Skip to content

docs: add business-friendly ML glossary with payments domain examples#331

Open
mitalidaduria wants to merge 7 commits into
open-metadata:mainfrom
mitalidaduria:main
Open

docs: add business-friendly ML glossary with payments domain examples#331
mitalidaduria wants to merge 7 commits into
open-metadata:mainfrom
mitalidaduria:main

Conversation

@mitalidaduria

Copy link
Copy Markdown

This PR adds clear, business-friendly translations and payments-domain examples for key technical data terms (Model Drift, Data Lineage, Feature Engineering, Label Skew, and Data Quality SLAs) to bridge the operational gap for business stakeholders referencing OpenMetadata's core conceptual glossary.

Expanded the metadata standard documentation to include detailed explanations of machine learning concepts such as model drift, data lineage, feature engineering, label skew, and data quality SLA.
add business-friendly ML glossary with payments domain examples
@kiran1287

Copy link
Copy Markdown
Contributor

As per technical writing standards, could you please fix these before merge:

  1. Add an introductory sentence — The ### Machine Learning & Data Governance Expansion heading is immediately followed by the #### Model Drift subheading with no body text in between, which the style guide flags (no heading should directly follow another heading). Suggested addition right after the section heading:

    "The following terms bridge common machine learning and data governance concepts to business-friendly language, with payments-domain examples showing how each one shows up in practice."

  2. Move the colon outside the bold markers — Field labels currently bold the colon along with the label text, e.g. **Technical Definition:**. Move it outside the asterisks instead: **Technical Definition**:. Apply this to all three labels (Technical Definition, Business Translation, Payments Example) across all five terms.

  3. Remove the numbering from the term headings#### 1. Model Drift, #### 2. Data Lineage, etc. imply a sequence or ranking, but these are five independent, equally-weighted glossary terms rather than sequential steps. Drop the numbers so headings read as #### Model Drift, #### Data Lineage, #### Feature Engineering, #### Label Skew, #### Data Quality SLA (Service Level Agreement).

Thanks!

@mitalidaduria

Copy link
Copy Markdown
Author

Hi @kiran1287, I've updated the file with the introductory sentence, changed the subheadings to the proper heading level without numbers, and moved the colons outside the bold formatting. Ready for another look!

kiran1287
kiran1287 previously approved these changes Jul 13, 2026
@kiran1287
kiran1287 dismissed their stale review July 13, 2026 18:10

Withdrawing approval — needs another look before merging.

@ayush-shah

Copy link
Copy Markdown
Member

Confirmed P1 finding on current head e219e8844cf78b39178697ddd201ea865a9dfc83:

v1.13.x/main-concepts/metadata-standard.mdx:1 now starts directly with ## Machine Learning & Data Governance Expansion. This removes the page's required frontmatter, H1, and the existing metadata-standard/schema overview, replacing the page rather than adding a glossary section. The repository guidance requires frontmatter on every page, and this route is still the canonical metadata-standard page. Please restore the original page structure and content, then append the glossary in an appropriate section or move it to a dedicated page wired into docs.json.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants