yujunjun/datahub
2
0
Fork 0
mirror of https://github.com/datahub-project/datahub.git synced 2025-12-27 09:58:14 +00:00
Code Issues Packages Projects Releases Wiki Activity

fix(docs): Updating Tag, Glossary Term docs to point to correct GraphQL methods (#6965)

Browse Source
This commit is contained in:
John Joyce 2023-01-09 11:24:17 -08:00 committed by GitHub
parent 432feaa16d
commit 1066615328
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
3 changed files with 33 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
datahub-graphql-core/src/main/resources/entity.graphql
View File

@ -1541,7 +1541,7 @@ type GlossaryTerm implements Entity {
type: EntityType!
"""
Name / id of the glossary term
A unique identifier for the Glossary Term. Deprecated - Use properties.name field instead.
"""
name: String! @deprecated
@ -3571,7 +3571,7 @@ type Tag implements Entity {
type: EntityType!
"""
The name / id of the tag. Use properties.name instead.
A unique identifier for the Tag. Deprecated - Use properties.name field instead.
"""
name: String! @deprecated

21
docs/glossary/business-glossary.md
View File

@ -86,10 +86,31 @@ In the modal that pops up you can select the Term you care about in one of two w
![](../imgs/glossary/add-term-modal.png)
## Managing Glossary with Git
In many cases, it may be preferable to manage the Business Glossary in a version-control system like git. This can make
managing changes across teams easier, by funneling all changes through a change management and review process.
To manage your glossary using Git, you can define it within a file and then use the DataHub CLI to ingest
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.
## Demo
Check out [our demo site](https://demo.datahubproject.io/glossary) to see an example Glossary and how it works!
### GraphQL
* [addTerm](../../graphql/mutations.md#addterm)
* [addTerms](../../graphql/mutations.md#addterms)
* [batchAddTerms](../../graphql/mutations.md#batchaddterms)
* [removeTerm](../../graphql/mutations.md#removeterm)
* [batchRemoveTerms](../../graphql/mutations.md#batchremoveterms)
* [createGlossaryTerm](../../graphql/mutations.md#createglossaryterm)
* [createGlossaryNode](../../graphql/mutations.md#createglossarynode) (Term Group)
You can easily fetch the Glossary Terms for an entity with a given its URN using the **glossaryTerms** property. Check out [Working with Metadata Entities](../api/graphql/querying-entities.md#querying-for-glossary-terms-of-an-asset) for an example.
## Resources
- [Creating a Business Glossary and Putting it to use in DataHub](https://blog.datahubproject.io/creating-a-business-glossary-and-putting-it-to-use-in-datahub-43a088323c12)
- [Tags and Terms: Two Powerful DataHub Features, Used in Two Different Scenarios](https://medium.com/datahub-project/tags-and-terms-two-powerful-datahub-features-used-in-two-different-scenarios-b5b4791e892e)

14
docs/tags.md
View File

@ -72,10 +72,16 @@ You can search for a tag in the search bar, and even filter entities by the pres
### GraphQL
* [Tag](../graphql/queries.md#tag)
* [AddTagsInput](../graphql/inputObjects.md#addtagsinput)
* [BatchAddTagsInput](../graphql/inputObjects.md#batchaddtagsinput)
* [BatchRemoveTagsInput](../graphql/inputObjects.md#batchremovetagsinput)
* [addTag](../graphql/mutations.md#addtag)
* [addTags](../graphql/mutations.md#addtags)
* [batchAddTags](../graphql/mutations.md#batchaddtags)
* [removeTag](../graphql/mutations.md#removetag)
* [batchRemoveTags](../graphql/mutations.md#batchremovetags)
* [createTag](../graphql/mutations.md#createtag)
* [updateTag](../graphql/mutations.md#updatetag)
* [deleteTag](../graphql/mutations.md#deletetag)
You can easily fetch the Tags for an entity with a given its URN using the **tags** property. Check out [Working with Metadata Entities](./api/graphql/querying-entities.md#querying-for-tags-of-an-asset) for an example.
### DataHub Blog