Skip to content
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

Merged
merged 23 commits into from
Aug 21, 2024

Conversation

rachhouse
Copy link
Contributor

@rachhouse rachhouse commented Aug 19, 2024

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:

  • Removes the About GX (Core version) page
  • Moves the Community Resources page out of the Introduction section to the bottom of the GX Core TOC
  • Renames the introduction sections to use "GX Core" instead of just "GX"

This PR was created for https://greatexpectations.atlassian.net/browse/DOC-818.


  • Description of PR changes above includes a link to an existing GitHub issue
  • PR title is prefixed with one of: [BUGFIX], [FEATURE], [DOCS], [MAINTENANCE], [CONTRIB]
  • Code is linted - run invoke lint (uses ruff format + ruff check)
  • Appropriate tests and docs have been updated

@rachhouse rachhouse self-assigned this Aug 19, 2024
Copy link

netlify bot commented Aug 19, 2024

Deploy Preview for niobium-lead-7998 canceled.

Name Link
🔨 Latest commit ed9d2f2
🔍 Latest deploy log https://app.netlify.com/sites/niobium-lead-7998/deploys/66c62427bb0b3900084b9808

Copy link

codecov bot commented Aug 19, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 79.67%. Comparing base (741fa7d) to head (ed9d2f2).
Report is 1 commits behind head on develop.

✅ 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     
Flag Coverage Δ
3.10 66.31% <ø> (ø)
3.11 66.31% <ø> (ø)
3.12 64.87% <ø> (ø)
3.12 aws_deps 45.79% <ø> (ø)
3.12 big 54.46% <ø> (ø)
3.12 filesystem 60.46% <ø> (ø)
3.12 mssql 49.89% <ø> (ø)
3.12 mysql 49.95% <ø> (ø)
3.12 postgresql 54.12% <ø> (ø)
3.12 spark 57.57% <ø> (ø)
3.12 trino 52.17% <ø> (ø)
3.8 66.35% <ø> (ø)
3.8 athena or clickhouse or openpyxl or pyarrow or project or sqlite or aws_creds 54.66% <ø> (ø)
3.8 aws_deps 45.82% <ø> (ø)
3.8 big 54.48% <ø> (ø)
3.8 databricks 47.10% <ø> (ø)
3.8 filesystem 60.47% <ø> (ø)
3.8 mssql 49.88% <ø> (ø)
3.8 mysql 49.94% <ø> (ø)
3.8 postgresql 54.10% <ø> (ø)
3.8 snowflake 48.01% <ø> (ø)
3.8 spark 57.54% <ø> (ø)
3.8 trino 52.16% <ø> (ø)
3.9 66.33% <ø> (ø)
cloud 0.00% <ø> (ø)
docs-basic 52.17% <ø> (+0.21%) ⬆️
docs-creds-needed 52.51% <ø> (ø)
docs-spark 51.93% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

Copy link
Contributor

@joshzzheng joshzzheng left a comment

Choose a reason for hiding this comment

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

  1. 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).
  2. Can we rename the workflows to just be DataFrame workflow and SQL workflow? Many people will use the exploratory workflow in production.
  3. What if we broke up Try GX into two quickstarts Try GX in DataFrames and Try GX in SQL

@rachhouse
Copy link
Contributor Author

rachhouse commented Aug 20, 2024

@joshzzheng

  1. 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).

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.

  1. Can we rename the workflows to just be DataFrame workflow and SQL workflow? Many people will use the exploratory workflow in production.

Great suggestion for simplification, I'll make that change.

  1. What if we broke up Try GX into two quickstarts Try GX in DataFrames and Try GX in SQL

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
Copy link
Contributor

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().

Copy link
Contributor Author

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!

@rachhouse rachhouse added this pull request to the merge queue Aug 21, 2024
Merged via the queue into develop with commit 00e9207 Aug 21, 2024
62 checks passed
@rachhouse rachhouse deleted the docs/doc-818/gx_core_overview_try_gx branch August 21, 2024 18:01
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants