docs(data product): Update example and docs

[eboneil]

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

Summary by CodeRabbit

• Documentation

  • Enhanced clarity on domain name handling in the DataHub system, emphasizing that the resolution process applies broadly across multiple fields.

• New Features

  • Added a new ownership entry in the data product metadata, allowing for more detailed ownership classification and improved tracking of responsibilities.

[coderabbitai]

Walkthrough

The recent changes enhance the DataHub documentation and metadata by clarifying the domain name resolution process and adding a new ownership entry. This improves user understanding of domain handling across multiple fields and refines ownership classification for data products, ultimately facilitating better management and tracking of responsibilities.

Changes

Files	Change Summary
docs/dataproducts.md	Clarified domain resolution process across multiple fields in documentation.
metadata-ingestion/examples/data_product/dataproduct.yaml	Added a new ownership entry under owners, improving ownership classification.

Poem

In fields of data where bunnies hop,
We clarify and make ownership pop! 🐰✨
A new entry added, our scope's now wide,
In the world of DataHub, we take great pride!
With clearer paths, we merrily play,
Hopping through changes, come join the fray! 🌼

---

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share

• X
• Mastodon
• Reddit
• LinkedIn

Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai generate interesting stats about this repository and render them as a table.
  • @coderabbitai show all the console.log statements in this repository.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (invoked as PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[coderabbitai]

Actionable comments posted: 0

Outside diff range, codebase verification and nitpick comments (1)

metadata-ingestion/examples/data_product/dataproduct.yaml (1)

16-17: The custom ownership type urn:li:ownershipType:architect is not recognized by the system.

Ensure that the custom ownership type is defined and registered in the appropriate configuration or service files.

• The custom ownership type urn:li:ownershipType:architect is only present in the dataproduct.yaml file and not defined elsewhere in the codebase.

Analysis chain

LGTM! Verify the custom ownership type.

The addition of a new owner with a custom ownership type enhances the granularity of ownership classification.

However, ensure that the custom ownership type urn:li:ownershipType:architect is recognized by the system.

Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Verify the custom ownership type `urn:li:ownershipType:architect` is recognized by the system.

# Test: Search for the custom ownership type definition. Expect: Definition of `urn:li:ownershipType:architect`.
rg --type yaml 'urn:li:ownershipType:architect'

Length of output: 181

---

Script:

#!/bin/bash
# Description: Verify where ownership types are defined or registered in the system.

# Test: Search for the term 'ownershipType' across the codebase to find where ownership types are defined or registered.
rg 'ownershipType'

Length of output: 53215

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between c2470f1 and b09ad61.

Files selected for processing (2)

• docs/dataproducts.md (1 hunks)
• metadata-ingestion/examples/data_product/dataproduct.yaml (1 hunks)

Files skipped from review due to trivial changes (1)

• docs/dataproducts.md