Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix(docs): fix sample business glossary #11669

Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ The business glossary source file should be a .yml file with the following top-l
Example **Glossary**:

```yaml
version: 1 # the version of business glossary file config the config conforms to. Currently the only version released is `1`.
version: "1" # the version of business glossary file config the config conforms to. Currently the only version released is `1`.
source: DataHub # the source format of the terms. Currently only supports `DataHub`
owners: # owners contains two nested fields
users: # (optional) a list of user IDs
Expand Down Expand Up @@ -60,7 +60,7 @@ Example **GlossaryTerm**:
- Shipping.CountryCode
- Shipping.StreetAddress
custom_properties: # (optional) a map of key/value pairs of arbitrary custom properties
- is_used_for_compliance_tracking: true
- is_used_for_compliance_tracking: "true"
knowledge_links: # (optional) a list of **KnowledgeCard** related to this term. These appear as links on the glossary node's page
- url: "https://en.wikipedia.org/wiki/Address"
label: Wiki link
Expand All @@ -73,7 +73,7 @@ To see how these all work together, check out this comprehensive example busines
<summary>Example business glossary file</summary>

```yaml
version: 1
version: "1"
source: DataHub
owners:
users:
Expand All @@ -89,15 +89,15 @@ nodes:
- name: Sensitive
description: Sensitive Data
custom_properties:
is_confidential: false
is_confidential: "false"
- name: Confidential
description: Confidential Data
custom_properties:
is_confidential: true
is_confidential: "true"
- name: HighlyConfidential
description: Highly Confidential Data
custom_properties:
is_confidential: true
is_confidential: "true"
domain: Marketing
- name: PersonalInformation
description: All terms related to personal information
Expand Down Expand Up @@ -148,7 +148,7 @@ nodes:
related_terms:
- Housing.Kitchen.Cutlery
custom_properties:
- is_used_for_compliance_tracking: true
- is_used_for_compliance_tracking: "true"
knowledge_links:
- url: "https://en.wikipedia.org/wiki/Address"
label: Wiki link
Expand Down Expand Up @@ -237,7 +237,7 @@ Source file linked [here](https://github.com/datahub-project/datahub/blob/master

## Generating custom IDs for your terms

IDs are normally inferred from the glossary term/node's name, see the `enable_auto_id` config. But, if you need a stable
IDs are normally inferred from the glossary term/node's name, see the `enable_auto_id` config. But, if you need a stable
identifier, you can generate a custom ID for your term. It should be unique across the entire Glossary.

Here's an example ID:
Expand All @@ -247,5 +247,5 @@ A note of caution: once you select a custom ID, it cannot be easily changed.

## Compatibility

Compatible with version 1 of business glossary format.
The source will be evolved as we publish newer versions of this format.
Compatible with version 1 of business glossary format.
The source will be evolved as we publish newer versions of this format.
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
version: 1
version: "1"
source: DataHub
owners:
users:
Expand Down Expand Up @@ -68,4 +68,4 @@ nodes:
- name: Auto Loan
description: "A type of loan used to finance the purchase of a vehicle, with the vehicle serving as collateral for the loan."
- name: Interest Rate
description: "The rate at which interest is charged on a loan or paid on an investment, expressed as a percentage of the principal amount."
description: "The rate at which interest is charged on a loan or paid on an investment, expressed as a percentage of the principal amount."
12 changes: 6 additions & 6 deletions metadata-ingestion/examples/bootstrap_data/business_glossary.yml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
version: 1
version: "1"
source: DataHub
owners:
users:
Expand All @@ -11,20 +11,20 @@ nodes:
- label: Wiki link for classification
url: "https://en.wikipedia.org/wiki/Classification"
custom_properties:
is_confidential: true
is_confidential: "true"
terms:
- name: Sensitive
description: Sensitive Data
custom_properties:
is_confidential: false
is_confidential: "false"
- name: Confidential
description: Confidential Data
custom_properties:
is_confidential: true
is_confidential: "true"
- name: HighlyConfidential
description: Highly Confidential Data
custom_properties:
is_confidential: true
is_confidential: "true"
domain: Marketing
- name: PersonalInformation
description: All terms related to personal information
Expand Down Expand Up @@ -72,7 +72,7 @@ nodes:
- Shipping.CountryCode
- Shipping.StreetAddress
custom_properties:
is_used_for_compliance_tracking: true
is_used_for_compliance_tracking: "true"
knowledge_links:
- url: "https://en.wikipedia.org/wiki/Address"
label: Wiki link
Expand Down
Loading