[DOCS] expectation details in asset history#11814
Conversation
✅ Deploy Preview for niobium-lead-7998 ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
There was a problem hiding this comment.
Pull request overview
Updates GX Cloud documentation to better describe how Expectation change details appear in Data Asset history and how to navigate between Expectation history and Data Asset history.
Changes:
- Clarifies that Data Asset history includes added/edited/removed Expectation events.
- Refines cross-links between “Expectation history” and “Data Asset history” sections for better navigation.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| docs/docusaurus/docs/cloud/expectations/manage_expectations.md | Adjusts the “deleted Expectations” tip text linking to Data Asset history. |
| docs/docusaurus/docs/cloud/data_assets/manage_data_assets.md | Updates Data Asset history description and refines the tip linking back to Expectation history. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| ## View Data Asset history | ||
|
|
||
| For an audit trail of who added or removed which Expectations and when, visit a Data Asset’s **History** tab. | ||
| For an audit trail of who added, edited, or removed which Expectations and when, visit a Data Asset’s **History** tab. |
There was a problem hiding this comment.
Wording is a bit ungrammatical: “removed which Expectations” is awkward. Consider rephrasing to “who added, edited, or removed Expectations, and when” (or similar) for readability.
| For an audit trail of who added, edited, or removed which Expectations and when, visit a Data Asset’s **History** tab. | |
| For an audit trail of who added, edited, or removed Expectations, and when, visit a Data Asset’s **History** tab. |
|
|
||
| :::tip Looking for deleted Expectations? | ||
| For an audit trail of who removed which Expectations and when, [view Data Asset history](/cloud/data_assets/manage_data_assets.md#view-data-asset-history). | ||
| For an audit trail of who added, edited, or removed a deleted Expectation and when, [view Data Asset history](/cloud/data_assets/manage_data_assets.md#view-data-asset-history). |
There was a problem hiding this comment.
The phrase “removed a deleted Expectation” reads as contradictory/unclear (an Expectation can be deleted/removed, but not “removed” after it’s already deleted). Suggest rewording to something like “added, edited, or deleted an Expectation” (or “added, edited, or removed an Expectation”) to clearly describe the actions captured in Data Asset history.
| For an audit trail of who added, edited, or removed a deleted Expectation and when, [view Data Asset history](/cloud/data_assets/manage_data_assets.md#view-data-asset-history). | |
| For an audit trail of who added, edited, or deleted an Expectation and when, [view Data Asset history](/cloud/data_assets/manage_data_assets.md#view-data-asset-history). |
Codecov Report✅ All modified and coverable lines are covered by tests.
Additional details and impacted files@@ Coverage Diff @@
## develop #11814 +/- ##
============================================
- Coverage 84.67% 63.49% -21.18%
============================================
Files 471 469 -2
Lines 39179 39177 -2
============================================
- Hits 33174 24877 -8297
- Misses 6005 14300 +8295 Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
|
Is this PR still relevant? If so, what is blocking it? Is there anything you can do to help move it forward? This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions 🙇 |
Docs in support of https://greatexpectations.atlassian.net/browse/GX-3135
invoke lint(usesruff format+ruff check)For more information about contributing, visit our community resources.
After you submit your PR, keep the page open and monitor the statuses of the various checks made by our continuous integration process at the bottom of the page. Please fix any issues that come up and reach out on Slack if you need help. Thanks for contributing!