Skip to content

docs(data-product): data product marketplace and hierarchy updates - #19614

Merged
ani-malgari merged 11 commits into
masterfrom
mwei-dataproduct-marketplace
Sep 4, 2026
Merged

ani-malgari merged 11 commits into
masterfrom
mwei-dataproduct-marketplace

Conversation

@manuelawei8

@manuelawei8 manuelawei8 commented Sep 4, 2026 •

Copy link
Copy Markdown
Contributor

Updates docs/dataproducts.md for the Data Product Marketplace and hierarchy features (DataHub Cloud 2.2.0).

What's covered

  • Creating a Data Product — both entry points: Govern → Data Product → Create, and from within a Domain
  • Discovery — Data Product home page, sidebar, search and filters
  • Data Product profile and lineage views
  • Hierarchy — defining nested Data Products, and moving/detaching a product
  • Privileges — a table mapping each operation to the privilege and policy resource it requires, since Manage Data Products (asset-side) and Manage Data Product (product-side) are easy to confuse

Notes

Checklist

  • PR conforms to the Contributing Guideline (PR Title Format)
  • Docs added/updated
  • Tests — n/a, docs only
  • Breaking changes — none

🤖 Generated with Claude Code


Summary by cubic

Updates docs/dataproducts.md to document DataHub Cloud 2.2.0's Data Product Marketplace and hierarchy features.

  • Covers both creation paths, home page and sidebar discovery, search and filters, profiles, lineage, nesting, moving, and detaching.
  • Documents the privilege each operation requires, including its policy resource scope, using the correct "Manage Data Products" name.
  • Fixes frontmatter, removes unused MDX imports, preserves the inline YAML directive, and removes stale Tabs references.
  • Screenshots are centered at 70% width with alt text and pinned to the static-assets commit carrying the recaptured tab image.

Written for commit 3f7b26c. Summary will update on new commits.

Review in cubic

Covers creating a Data Product from the marketplace, the Data Product
home page and sidebar with search and filters, the product profile and
lineage views, and defining a Data Product hierarchy. Also documents the
privileges each operation requires.

Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
@cursor

cursor Bot commented Sep 4, 2026 •

Copy link
Copy Markdown

PR Summary

Overview
Updates docs/dataproducts.md for DataHub Cloud 2.2.0 Data Product Marketplace and hierarchy: version callout, discovery via Govern → Data Products, and refreshed screenshots (with alt text) pinned to a new static-assets commit.

Permissions and behavior — The operations table is expanded to separate marketplace flows (create from Govern, browse/dataproduct, Move via moveDataProduct) from Domain- and asset-side actions, with clearer policy-resource columns. New notes cover domain-scoped Manage Data Products, updateName / Edit Entity, MCP vs UI authorization, and a domain drift caution when domains change without re-checking membership.

User-facing structure — UI creation is documented as two paths (marketplace create, including optional parent, vs Domain tab). A new Discover Data Products section covers the home page, lazy sidebar tree, search/filters, profile (sub-products, Move), and lineage. Hierarchy content is reframed as Define Data Product Hierarchy with UI move and a move-dialog screenshot.

Docs cleanup — Removes unused MDX imports (FeatureAvailability, Tabs/TabItem) and presents the YAML example and JSON schema inline instead of in tabs.

Reviewed by Cursor Bugbot for commit 3f7b26c. Bugbot is set up for automated code reviews on this repo. Configure here.

@github-actions github-actions Bot added the docs Issues and Improvements to docs label Sep 4, 2026

@cubic-dev-ai cubic-dev-ai Bot left a comment •

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

All reported issues were addressed across 1 file

Reply with feedback, questions, or to request a fix.

Re-trigger cubic

Comment thread docs/dataproducts.md Outdated
Comment thread docs/dataproducts.md Outdated
Comment thread docs/dataproducts.md Outdated
Comment thread docs/dataproducts.md Outdated
@maggiehays maggiehays added the needs-review Label for PRs that need review from a maintainer. label Sep 4, 2026
manuelawei8 and others added 3 commits September 4, 2026 10:19
A blank line after the opening `---` broke the frontmatter block, so the
`description` key was parsed as a setext heading instead of metadata.

Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
The rewrite replaced <FeatureAvailability/> and the Tabs block with plain
sections, leaving all three component imports unused. It also dropped the
prettier-ignore guards around the YAML example, so formatting rewrote the
`{{ inline ... }}` directive as a nested flow mapping and broke the file
substitution at docs build time. Restore the guards with the directive.

Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
The Tabs block was flattened into plain sections, so the prose no longer
matches the page. Point at the spec that follows the example instead.

Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
Comment thread docs/dataproducts.md Outdated
Comment thread docs/dataproducts.md Outdated
| Link or unlink a Data Product from an asset profile | Asset sidebar → Set Data Product; `batchAddToDataProducts` / `batchRemoveFromDataProducts` | **Edit Data Product** | The **asset** being updated |
| What you're doing | Where in the UI / API | Required privilege | Policy resource |
| --------------------------------------------------- | ------------------------------------------------------------------------------------------ | ------------------------- | ------------------------------------------------ |
| Create, update, or delete a Data Product | Domain → Data Products tab; `createDataProduct`, `updateDataProduct`, `deleteDataProduct` | **Manage Data Products** | Each **Domain** associated with the product |

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't know if we still want to keep this if we encourage people to use the Marketplace. Even if we keep it, i think we should move it below the Marketplace items

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

kept data product management from Domain but moved to the bottom

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

it's still reflecting the old way

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Image

Comment thread docs/dataproducts.md Outdated
Comment thread docs/dataproducts.md Outdated
The Data Product profile includes:

- **Summary → Sub-products** — direct children in the hierarchy
- **Summary → Output Ports** — assets marked as the product's published outputs

@ani-malgari ani-malgari Sep 4, 2026 •

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

we render all assets in Summary, not output ports.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
- **Summary → Output Ports** — assets marked as the product's published outputs
- **Summary → Assets** — all assets that are part of the data product

Comment thread docs/dataproducts.md Outdated
Comment thread docs/dataproducts.md Outdated
Comment thread docs/dataproducts.md Outdated
Comment thread docs/dataproducts.md
manuelawei8 and others added 2 commits September 4, 2026 12:23
Bare markdown images rendered full-width and left-aligned, unlike the
rest of the docs, where screenshots use a centered img at 70% width. The
four pre-existing screenshots had that markup before this branch. Restore
it for all nine and add alt text.

Also force a line break in the version-compatibility note so the two
lines render separately instead of collapsing into one paragraph.

Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
dataproducts-tab.png is only 766px wide, so at 70% of the content column
it upscales on 2x displays and looks soft. 50% keeps it within its native
resolution. The other screenshots are 1250-2664px wide and stay at 70%.

Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
Points all nine screenshots at the static-assets commit that carries the
recaptured Data Products tab image, and puts that image back to the 70%
width used everywhere else now that it has the resolution for it.

Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
@manuelawei8

Copy link
Copy Markdown
Contributor Author

Review resolution summary

All review feedback is addressed. Each point below maps to the commit that resolved it.

# Issue Fix Commit
1 YAML frontmatter broken — a blank line after the opening --- made description: parse as a setext heading, rendering a stray ## description: and dropping the page metadata Restored the 3-line frontmatter block; now byte-identical to master 20d16e40
2 {{ inline ... }} macro rewritten as { { inline ..., }, }, which would ship literal braces instead of the example YAML Restored the macro and the <!-- prettier-ignore-start/end --> guards whose removal allowed Prettier to reformat it e1aede4c
3 <FeatureAvailability/>, Tabs, and TabItem imports left unused after the rewrite flattened the tab block Dropped all three e1aede4c
4 Prose still referenced "The Spec tab" after the <Tabs> wrapper was removed Reworded to point at the spec that follows the example 0436937b
5 Screenshots used bare markdown images — full-width and left-aligned, unlike the rest of the docs Converted all 9 to the house <p align="center"><img width="70%"> pattern, with alt text added 854b58fa
6 dataproducts-tab.png was 766px wide and looked soft at 70% on 2x displays Recaptured at 1084×424 in static-assets (#230, merged) and restored the 70% width c7856704, 953b7c9a

Notes

  • Image URLs are pinned to static-assets 3ca67aad (the implement the ownership section for metadata dashboard #230 merge commit). All nine were verified to return HTTP 200 with the expected byte sizes.
  • Version-compatibility note now uses <br /> so its two lines render separately instead of collapsing into one paragraph.
  • Verification: ./gradlew :datahub-web-react:mdPrettierCheck passes. Also checked manually — frontmatter parses, relative links resolve, sidebar entry present at sidebars.js:464, and both {{ inline }} targets are correct (dataproduct_schema.json lives under the build-generated docs/generated/, same as on master).

Six of the seven commits are fixups to the first, so this is a good candidate for squash-on-merge.

Reorders the privilege table around the Data Product sidebar entry points,
names the Domain path explicitly, and drops the Marketplace phrasing.
Lists Summary → Assets on the profile, simplifies the discovery and
hierarchy wording.

Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
Comment thread docs/dataproducts.md Outdated

@cubic-dev-ai cubic-dev-ai Bot left a comment •

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

All reported issues were addressed across 1 file (changes from recent commits).

Tip: Review your code locally with the cubic CLI to iterate faster.

Re-trigger cubic

Comment thread docs/dataproducts.md Outdated
Co-authored-by: cubic-dev-ai[bot] <191113872+cubic-dev-ai[bot]@users.noreply.github.com>
manuelawei8 and others added 2 commits September 4, 2026 13:28
The privilege is MANAGE_DATA_PRODUCTS, displayed as "Manage Data
Products". Two table rows used a singular form that does not exist.

Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
@ani-malgari
ani-malgari merged commit f9cf060 into master Sep 4, 2026
23 checks passed
@ani-malgari
ani-malgari deleted the mwei-dataproduct-marketplace branch September 4, 2026 22:43

This branch was successfully deployed

1 active deployment
Preview — 3f7b26c8 Deployed Sep 4, 2026 by vercel[bot]
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

docs Issues and Improvements to docs needs-review Label for PRs that need review from a maintainer.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants