Docs: Data Contracts Section fixed and Added in 1.10 and 1.11 #510
Conversation
✅ Deploy Preview for docsv1 ready!Built without sensitive environment variables
To edit notification comments on pull requests, go to your Netlify project configuration. |
There was a problem hiding this comment.
Pull Request Overview
This PR adds comprehensive Data Contracts documentation across versions 1.9.x, 1.10.x, and 1.11.x of OpenMetadata. The documentation provides guidance on understanding, specifying, and creating data contracts for table assets.
- Added Data Contracts section to navigation menus across all three versions
- Enhanced existing documentation with version-specific video content (OSS and Collate)
- Created new specification and creation guide documentation for v1.10.x and v1.11.x
Reviewed Changes
Copilot reviewed 11 out of 25 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| content/v1.9.x/menu.md | Added Data Contracts navigation entries |
| content/v1.9.x/how-to-guides/data-contracts/index.md | Added version-specific video embeds with OSS/Collate content blocks |
| content/v1.9.x/how-to-guides/data-contracts/create.md | Updated description metadata |
| content/v1.11.x-SNAPSHOT/menu.md | Added Data Contracts navigation entries |
| content/v1.11.x-SNAPSHOT/how-to-guides/data-contracts/spec.md | New file documenting Data Contract JSON Schema specification |
| content/v1.11.x-SNAPSHOT/how-to-guides/data-contracts/index.md | New index file with overview and video content |
| content/v1.11.x-SNAPSHOT/how-to-guides/data-contracts/create.md | New step-by-step guide for creating Data Contracts |
| content/v1.10.x/menu.md | Added Data Contracts navigation entries |
| content/v1.10.x/how-to-guides/data-contracts/spec.md | New file documenting Data Contract JSON Schema specification |
| content/v1.10.x/how-to-guides/data-contracts/index.md | New index file with overview and video content |
| content/v1.10.x/how-to-guides/data-contracts/create.md | New step-by-step guide for creating Data Contracts |
Comments suppressed due to low confidence (7)
content/v1.10.x/how-to-guides/data-contracts/create.md:1
- Image path references v1.11 directory but this file is in v1.10.x documentation. The path should be '/images/v1.10/how-to-guides/contracts/create1.png' to match the version.
content/v1.10.x/how-to-guides/data-contracts/create.md:1 - Image path references v1.11 directory but this file is in v1.10.x documentation. The path should be '/images/v1.10/how-to-guides/contracts/create2.png' to match the version.
content/v1.10.x/how-to-guides/data-contracts/create.md:1 - Image path references v1.11 directory but this file is in v1.10.x documentation. The path should be '/images/v1.10/how-to-guides/contracts/create3.png' to match the version.
content/v1.10.x/how-to-guides/data-contracts/create.md:1 - Image path references v1.11 directory but this file is in v1.10.x documentation. The path should be '/images/v1.10/how-to-guides/contracts/create4.png' to match the version.
content/v1.10.x/how-to-guides/data-contracts/create.md:1 - Image path references v1.11 directory but this file is in v1.10.x documentation. The path should be '/images/v1.10/how-to-guides/contracts/create5.png' to match the version.
content/v1.10.x/how-to-guides/data-contracts/create.md:1 - Image path references v1.11 directory but this file is in v1.10.x documentation. The path should be '/images/v1.10/how-to-guides/contracts/create6.png' to match the version.
content/v1.10.x/how-to-guides/data-contracts/create.md:1 - Image path references v1.11 directory but this file is in v1.10.x documentation. The path should be '/images/v1.10/how-to-guides/contracts/create7.png' to match the version.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Co-authored-by: Ayush Shah <[email protected]>
There was a problem hiding this comment.
Pull Request Overview
Copilot reviewed 11 out of 25 changed files in this pull request and generated 7 comments.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
There was a problem hiding this comment.
Pull Request Overview
Copilot reviewed 11 out of 25 changed files in this pull request and generated 1 comment.
Comments suppressed due to low confidence (1)
content/v1.10.x/how-to-guides/data-contracts/spec.md:1
- The introduction states 'four main categories' but then lists seven items (Schema, Semantics, Security, Business Assertions, SLA, Terms of Use, Status). Update the count to 'seven main categories' or clarify which are primary vs. secondary categories.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Co-authored-by: Copilot <[email protected]>
There was a problem hiding this comment.
Pull Request Overview
Copilot reviewed 11 out of 25 changed files in this pull request and generated 1 comment.
Comments suppressed due to low confidence (1)
content/v1.10.x/how-to-guides/data-contracts/spec.md:1
- The title 'Creating Data Contracts' is inconsistent with the file purpose. This is a specification file (spec.md) that documents the data contract schema and structure, not a creation guide. The title should be 'Data Contract Specification' or similar to match the actual content.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
There was a problem hiding this comment.
Pull Request Overview
Copilot reviewed 11 out of 25 changed files in this pull request and generated 1 comment.
Comments suppressed due to low confidence (1)
content/v1.10.x/how-to-guides/data-contracts/spec.md:1
- [nitpick] The ellipsis notation ',...' should be replaced with 'etc.' or 'and so on' for better clarity in technical documentation.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
|
|
||
| Service-Level Agreements related to the data’s timeliness and lifecycle are captured in this section. | ||
| This includes: | ||
| Refresh Frequency: how often the data is expected to be updated or refreshed (e.g., daily, weekly,...). |
There was a problem hiding this comment.
[nitpick] The ellipsis notation ',...' should be replaced with 'etc.' or 'and so on' for better clarity in technical documentation.
| Refresh Frequency: how often the data is expected to be updated or refreshed (e.g., daily, weekly,...). | |
| Refresh Frequency: how often the data is expected to be updated or refreshed (e.g., daily, weekly, etc.). |
3 participants
I worked on Data Contracts Section fixed and Added in 1.10v and 1.11v.