docs(approval workflows): adding approval workflow docs #5896

gabe-lyons · 2022-09-09T21:19:21Z

Checklist

The PR conforms to DataHub's Contributing Guideline (particularly Commit Message Format)
Links to related issues (if applicable)
Tests for the changes have been added/updated (if applicable)
Docs related to the changes have been added/updated (if applicable). If a new feature has been added a Usage Guide has been added for the same.
For any breaking change/potential downtime/deprecation/big changes an entry has been made in Updating DataHub

jjoyce0510 · 2022-09-10T20:56:36Z

docs/managed-datahub/approval-workflows.md

+import FeatureAvailability from '@site/src/components/FeatureAvailability';
+
+# Approval Workflows
+


We need to make it clear that this functionality is currently incubating, only available for datasets.

maggiehays · 2022-09-14T17:28:32Z

docs/managed-datahub/approval-workflows.md

@@ -0,0 +1,184 @@
+import FeatureAvailability from '@site/src/components/FeatureAvailability';
+
+# Approval Workflows


Change to About DataHub Approval Workflows - this should help with SEO

maggiehays · 2022-09-14T17:29:48Z

docs/managed-datahub/approval-workflows.md

+
+## Overview
+
+Keeping all your metadata properly classified can be hard work when you only have a limited number of trusted data stewards. With Acryl, you can source proposals of tags and glossary terms associated to datasets or dataset schema fields. These proposals may come from users with limited context or programatic processes using hueristics. Then, data stewards and data owners can go through them and only approve proposals they consider correct. This reduces the burden of your stewards and owners while increasing coverage.


Should we do With Managed DataHub instead of With Acryl? Our Feature Availability component calls it the former

Prop case Tags, Glossary Terms, Dataset, Dataset Schema

addressing!

maggiehays · 2022-09-14T17:30:27Z

docs/managed-datahub/approval-workflows.md

+
+Keeping all your metadata properly classified can be hard work when you only have a limited number of trusted data stewards. With Acryl, you can source proposals of tags and glossary terms associated to datasets or dataset schema fields. These proposals may come from users with limited context or programatic processes using hueristics. Then, data stewards and data owners can go through them and only approve proposals they consider correct. This reduces the burden of your stewards and owners while increasing coverage.
+
+Approval workflows also cover the business glossary itself. This allows you to source glossary terms and glossary term description changes from across your organization while limiting who has final control over what gets in.


Prop case Business Glossary & Glossary Term

maggiehays · 2022-09-14T17:33:07Z

docs/managed-datahub/approval-workflows.md

+
+Approval workflows also cover the business glossary itself. This allows you to source glossary terms and glossary term description changes from across your organization while limiting who has final control over what gets in.
+
+## Using Approval Workflows


👏 love this whole section

maggiehays · 2022-09-14T17:34:14Z

docs/managed-datahub/approval-workflows.md

+`urn:li:tag:<id>`
+
+Glossary Term URNs have the following format:
+urn:li:glossaryTerm:<id>


Enclose with `` -- urn:li:glossaryTerm:<id>

maggiehays · 2022-09-14T17:39:48Z

docs/managed-datahub/approval-workflows.md

+
+Specific Metadata Entity types have additional sub-resources to which tags may be applied.
+Today, this only applies for Dataset Metadata Entities, which have a "fields" sub-resource, with each field uniquely identified using a standard path format, reflecting its place within the Dataset's data schema.
+To construct a field path, see Constructing Dataset Field Paths.


Do we have a link out to Constructing Dataset Field Paths?

maggiehays · 2022-09-14T17:40:16Z

docs/managed-datahub/approval-workflows.md

+Glossary Term URNs have the following format:
+urn:li:glossaryTerm:<id>
+
+These full identifiers can be copied from the entity pages of the Tag or Glossary Term.


Let's add a screenshot of how to copy URN from the entity page

maggiehays · 2022-09-14T17:41:09Z

docs/managed-datahub/approval-workflows.md

+
+Once we've constructed an Entity URN, any relevant sub-resource identifiers, and a Tag or Term URN, we're ready to propose! To do so, we'll use the DataHub GraphQL API.
+
+In particular, we'll be using the proposeTag, proposeGlossaryTerm and proposeUpdateDescription Mutations, which have the following interface:


edit: proposeTag, proposeGlossaryTerm, and proposeUpdateDescription

maggiehays · 2022-09-14T17:41:59Z

docs/managed-datahub/approval-workflows.md

+- Propose Glossary Terms - Allows to propose terms at the Entity level
+- Propose Dataset Column Glossary Terms - Allows to propose terms at the Dataset Field level
+
+To be able to see the proposals Tab you need the <strong>"View Metadata Proposals"</strong> PLATFORM privilege


Proposals Tab

maggiehays · 2022-09-14T17:42:39Z

docs/managed-datahub/approval-workflows.md

+- Manage Glossary Term Proposals
+- Manage Dataset Column Tag Proposals
+- Manage Dataset Column Term Proposals
+  These map directly to the 4 privileges for doing the proposals


Add in line break after list

gabe-lyons · 2022-09-27T00:25:43Z

@maggiehays addressed!

github-actions · 2022-09-27T00:56:48Z

Unit Test Results (build & test)

584 tests ±0 580 ✔️ ±0 13m 1s ⏱️ -4s
143 suites ±0     4 💤 ±0
143 files ±0     0 ❌ ±0

Results for commit 1d788b0. ± Comparison against base commit 3eace64.

♻️ This comment has been updated with latest results.

gabe-lyons added 4 commits September 9, 2022 09:51

updated approval docs

7164e12

further updating proposals doc

c6bd4fc

adding approval docs

1ae65ea

delete old file

e6e8d9e

anshbansal added the docs Issues and Improvements to docs label Sep 10, 2022

jjoyce0510 reviewed Sep 10, 2022

View reviewed changes

clarified the purpose of approval flows

6048d61

maggiehays requested changes Sep 14, 2022

View reviewed changes

gabe-lyons added 3 commits September 26, 2022 16:49

Merge branch 'master' into gabe--addingProposalDocs

1ff8f3d

addressing comments

338449b

updating sidebars

cdfc0cd

gabe-lyons added 2 commits September 27, 2022 08:14

update iframe

05a676e

update index

1d788b0

maggiehays approved these changes Sep 27, 2022

View reviewed changes

gabe-lyons merged commit 63007cf into datahub-project:master Sep 27, 2022

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

docs(approval workflows): adding approval workflow docs #5896

docs(approval workflows): adding approval workflow docs #5896

gabe-lyons commented Sep 9, 2022

jjoyce0510 Sep 10, 2022

maggiehays Sep 14, 2022

maggiehays Sep 14, 2022

maggiehays Sep 14, 2022

gabe-lyons Sep 26, 2022

maggiehays Sep 14, 2022

maggiehays Sep 14, 2022

maggiehays Sep 14, 2022

gabe-lyons Sep 26, 2022

maggiehays Sep 14, 2022

maggiehays Sep 14, 2022

maggiehays Sep 14, 2022

maggiehays Sep 14, 2022 •

edited

Loading

maggiehays Sep 14, 2022

gabe-lyons commented Sep 27, 2022

github-actions bot commented Sep 27, 2022 •

edited

Loading

		import FeatureAvailability from '@site/src/components/FeatureAvailability';

		# Approval Workflows

		@@ -0,0 +1,184 @@
		import FeatureAvailability from '@site/src/components/FeatureAvailability';

		# Approval Workflows


		## Overview

		Keeping all your metadata properly classified can be hard work when you only have a limited number of trusted data stewards. With Acryl, you can source proposals of tags and glossary terms associated to datasets or dataset schema fields. These proposals may come from users with limited context or programatic processes using hueristics. Then, data stewards and data owners can go through them and only approve proposals they consider correct. This reduces the burden of your stewards and owners while increasing coverage.


		Keeping all your metadata properly classified can be hard work when you only have a limited number of trusted data stewards. With Acryl, you can source proposals of tags and glossary terms associated to datasets or dataset schema fields. These proposals may come from users with limited context or programatic processes using hueristics. Then, data stewards and data owners can go through them and only approve proposals they consider correct. This reduces the burden of your stewards and owners while increasing coverage.

		Approval workflows also cover the business glossary itself. This allows you to source glossary terms and glossary term description changes from across your organization while limiting who has final control over what gets in.


		Approval workflows also cover the business glossary itself. This allows you to source glossary terms and glossary term description changes from across your organization while limiting who has final control over what gets in.

		## Using Approval Workflows


		Once we've constructed an Entity URN, any relevant sub-resource identifiers, and a Tag or Term URN, we're ready to propose! To do so, we'll use the DataHub GraphQL API.

		In particular, we'll be using the proposeTag, proposeGlossaryTerm and proposeUpdateDescription Mutations, which have the following interface:

docs(approval workflows): adding approval workflow docs #5896

docs(approval workflows): adding approval workflow docs #5896

Conversation

gabe-lyons commented Sep 9, 2022

Checklist

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

maggiehays Sep 14, 2022 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

gabe-lyons commented Sep 27, 2022

github-actions bot commented Sep 27, 2022 • edited Loading

Unit Test Results (build & test)

maggiehays Sep 14, 2022 •

edited

Loading

github-actions bot commented Sep 27, 2022 •

edited

Loading