-
Notifications
You must be signed in to change notification settings - Fork 1.6k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
[DOCS] DOC-818: Update GX Core Overview and Try GX #10237
Conversation
✅ Deploy Preview for niobium-lead-7998 canceled.
|
Codecov ReportAll modified and coverable lines are covered by tests ✅
✅ All tests successful. No failed tests found. Additional details and impacted files@@ Coverage Diff @@
## develop #10237 +/- ##
========================================
Coverage 79.67% 79.67%
========================================
Files 454 454
Lines 39551 39551
========================================
+ Hits 31511 31512 +1
+ Misses 8040 8039 -1
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
- In overview, I would put the info on exploratory vs production workflow info before all the glossary definitions (frankly no one will read all that text in the beginning).
- Can we rename the workflows to just be DataFrame workflow and SQL workflow? Many people will use the exploratory workflow in production.
- What if we broke up Try GX into two quickstarts Try GX in DataFrames and Try GX in SQL
I disagree, I think the Overview material needs to be covered first. If anything, I'm not sure the Exploratory vs. Production section belongs in the Overview, I think it might make more sense as a separate Learn page - particularly if we rename the Try GX sections to be just dataframe vs. sql workflows.
Great suggestion for simplification, I'll make that change.
I'd like to keep them on the same page for now and see how it goes. |
# Import required modules from GX library. | ||
# <snippet name="docs/docusaurus/docs/core/introduction/try_gx_end_to_end.py import gx library"> | ||
import great_expectations as gx | ||
import great_expectations.expectations as gxe |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
To minimize extra imports, elsewhere in the docs we've stopped using import great_expectations.expectations as gxe
. Instead, when Expectations are created we're using gx.expectations.ExpectWhatever()
instead of gxe.ExpectWhatever()
.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'll update to just import great_expectations
and use the gx
alias. Thanks for the heads up!
for more information, see https://pre-commit.ci
for more information, see https://pre-commit.ci
This PR updates the GX Core Overview and Try GX pages to more clearly spell out the steps in a GX workflow and provide two sample workflows for Try GX.
The relevant Netlify pages are:
This PR also takes care of a few requested docs TOC changes:
This PR was created for https://greatexpectations.atlassian.net/browse/DOC-818.
invoke lint
(usesruff format
+ruff check
)