Skip to content

Instantly share code, notes, and snippets.

@aparnachaudhary
Created November 10, 2021 09:25
Show Gist options
  • Save aparnachaudhary/c8381cf926f7417bfe7deb9910191221 to your computer and use it in GitHub Desktop.
Save aparnachaudhary/c8381cf926f7417bfe7deb9910191221 to your computer and use it in GitHub Desktop.

Maintain Business Glossary in (W3C) Standard Format

Context and Problem Statement

We want to maintain business glossary in the organization. Multiple Data Catalogs support Business Glossary but no standard format is used. W3C standard exists to maintain this information.

How to import business glossary maintained in W3C standard to DataHub Catalog?

Decision Drivers

  • Generally big organizations have multiple technology stacks; meaning different Data Catalogs. Business Glossary MUST be inter-operable across Data Catalogs.
  • Some organizations have already invested in Web Ontology Language (OWL). DataHub SHALL provide easy onboarding for such organizations.

Considered Options

  • Create a standalone tool to convert OWL to DataHub Business Glossary YAML
  • Create a standalone tool to ingest OWL to DataHub using GraphQL API

Decision Outcome

Chosen option: "{option 1}", because {justification. e.g., only option, which meets k.o. criterion decision driver | which resolves force {force} | … | comes out best (see below)}.

Positive Consequences

  • {e.g., improvement of quality attribute satisfaction, follow-up decisions required, …}

Negative Consequences

  • {e.g., compromising quality attribute, follow-up decisions required, …}

Pros and Cons of the Options

{option 1}

{example | description | pointer to more information | …}

  • Good, because {argument a}
  • Good, because {argument b}
  • Bad, because {argument c}

{option 2}

{example | description | pointer to more information | …}

  • Good, because {argument a}
  • Good, because {argument b}
  • Bad, because {argument c}

{option 3}

{example | description | pointer to more information | …}

  • Good, because {argument a}
  • Good, because {argument b}
  • Bad, because {argument c}

Links

  • {Link type} {Link to ADR}
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment