Skip to content

Commit

Permalink
fix(docs): Adding relationship types section to Business Glossary docs (
Browse files Browse the repository at this point in the history
  • Loading branch information
jjoyce0510 authored May 3, 2023
1 parent b12c2b8 commit 36cb2b0
Showing 1 changed file with 22 additions and 0 deletions.
22 changes: 22 additions & 0 deletions docs/glossary/business-glossary.md
Original file line number Diff line number Diff line change
Expand Up @@ -94,6 +94,28 @@ To manage your glossary using Git, you can define it within a file and then use
it into DataHub whenever a change is made (e.g. on a `git commit` hook). For detailed information about the format of
the glossary file, and how to ingest it into DataHub, check out the [Business Glossary](../generated/ingestion/sources/business-glossary.md) source guide.

## About Glossary Term Relationships

DataHub supports 2 different kinds of relationships _between_ individual Glossary Terms: **Inherits From** and **Contains**.

**Contains** can be used to relate two Glossary Terms when one is a _superset_ of or _consists_ of another.
For example: **Address** Term _Contains_ **Zip Code** Term, **Street** Term, & **City** Term (_Has-A_ style relationship)

**Inherits** can be used to relate two Glossary Terms when one is a _sub-type_ or _sub-category_ of another.
For example: **Email** Term _Inherits From_ **PII** Term (_Is-A_ style relationship)

These relationship types allow you to map the concepts existing within your organization, enabling you to
change the mapping between concepts behind the scenes, without needing to change the Glossary Terms
that are attached to individual Data Assets and Columns.

For example, you can define a very specific, concrete Glossary Term like `Email Address` to represent a physical
data type, and then associate this with a higher-level `PII` Glossary Term via an `Inheritance` relationship.
This allows you to easily maintain a set of all Data Assets that contain or process `PII`, while keeping it easy to add
and remove new Terms from the `PII` Classification, e.g. without requiring re-annotation of individual Data Assets or Columns.




## Demo

Check out [our demo site](https://demo.datahubproject.io/glossary) to see an example Glossary and how it works!
Expand Down

0 comments on commit 36cb2b0

Please sign in to comment.