ni / ni/datastore-python

Significant Learning Curve for Teams Adopting or Migrating to MDS

Open
#101 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

documentation
Dominant language
Python
Stars
2
Forks
0
Avg merge
1d 14h
Merged PRs (30d)
6

Description

Users must manually handle session maintenance, metadata object creation flows, and interactions with various MDS entities.

Customer use cases:

  1. Integrating MDS into newly created measurements
  2. Migrating existing logging frameworks to MDS

Impact:

  1. Increased onboarding time
  2. Higher likelihood of integration errors
  3. Reduced approachability for new adopters

Suggestion:

Product documentation (with pictorial representation) on MDS entities (TestResult, Step... metadatas, schema registration) with real case scenarios will be helpful.

AB#3744855

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with docs/design/mds/entity-relationships.png and review the existing documentation for MDS entities, session maintenance, metadata creation, and schema registration. Add guidance for the two stated use cases—new measurements and migration from existing logging frameworks—with real-case scenarios. Done means newcomers can understand the entity relationships and integration flow without manually piecing them together.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.