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] Revised glossary for GX 1.0 #9714

Open
wants to merge 3 commits into
base: develop
Choose a base branch
from

Conversation

Rachel-Reverie
Copy link
Contributor

@Rachel-Reverie Rachel-Reverie commented Apr 5, 2024

Description:

  • Definitions provided for persisted objects in the GX Core Domain Model
  • Definitions provided for additional objects referenced in the Docs
  • Links from Definitions to relevant documentation on how to use/manage the object in question.

Definition of done:

  • PR title is prefixed with one of: [BUGFIX], [FEATURE], [DOCS], [MAINTENANCE], [CONTRIB]
  • Appropriate tests and docs have been updated

… Docs" along with the persisted objects in the GX Core Domain Model.
Copy link

netlify bot commented Apr 5, 2024

Deploy Preview for niobium-lead-7998 ready!

Name Link
🔨 Latest commit 87d2037
🔍 Latest deploy log https://app.netlify.com/sites/niobium-lead-7998/deploys/66102c2449d26a0008a3fd9b
😎 Deploy Preview https://deploy-preview-9714.docs.greatexpectations.io
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

Copy link

codecov bot commented Apr 5, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 82.54%. Comparing base (edc1000) to head (87d2037).
Report is 1 commits behind head on develop.

Additional details and impacted files
@@           Coverage Diff            @@
##           develop    #9714   +/-   ##
========================================
  Coverage    82.54%   82.54%           
========================================
  Files          511      511           
  Lines        46466    46469    +3     
========================================
+ Hits         38354    38357    +3     
  Misses        8112     8112           
Flag Coverage Δ
3.10 64.61% <ø> (+<0.01%) ⬆️
3.10 athena or clickhouse or openpyxl or pyarrow or project or sqlite or aws_creds ?
3.10 aws_deps ?
3.10 big ?
3.10 databricks ?
3.10 filesystem ?
3.10 mssql ?
3.10 mysql ?
3.10 postgresql ?
3.10 snowflake ?
3.10 spark ?
3.10 trino ?
3.11 64.61% <ø> (+<0.01%) ⬆️
3.11 athena or clickhouse or openpyxl or pyarrow or project or sqlite or aws_creds 53.93% <ø> (+<0.01%) ⬆️
3.11 aws_deps 48.98% <ø> (+<0.01%) ⬆️
3.11 big 63.95% <ø> (+<0.01%) ⬆️
3.11 databricks 48.18% <ø> (+<0.01%) ⬆️
3.11 filesystem 63.84% <ø> (+<0.01%) ⬆️
3.11 mssql 47.40% <ø> (+<0.01%) ⬆️
3.11 mysql 47.45% <ø> (+<0.01%) ⬆️
3.11 postgresql 54.22% <ø> (+<0.01%) ⬆️
3.11 snowflake 48.71% <ø> (+<0.01%) ⬆️
3.11 spark 60.64% <ø> (+<0.01%) ⬆️
3.11 trino 53.86% <ø> (+<0.01%) ⬆️
3.8 64.62% <ø> (+<0.01%) ⬆️
3.8 athena or clickhouse or openpyxl or pyarrow or project or sqlite or aws_creds 53.94% <ø> (+<0.01%) ⬆️
3.8 aws_deps 48.99% <ø> (+<0.01%) ⬆️
3.8 big 63.95% <ø> (+<0.01%) ⬆️
3.8 databricks 48.19% <ø> (+<0.01%) ⬆️
3.8 filesystem 63.85% <ø> (+<0.01%) ⬆️
3.8 mssql 47.38% <ø> (+<0.01%) ⬆️
3.8 mysql 47.43% <ø> (+<0.01%) ⬆️
3.8 postgresql 54.21% <ø> (+<0.01%) ⬆️
3.8 snowflake 48.73% <ø> (+<0.01%) ⬆️
3.8 spark 60.60% <ø> (+<0.01%) ⬆️
3.8 trino 53.85% <ø> (+<0.01%) ⬆️
3.9 64.62% <ø> (+<0.01%) ⬆️
3.9 athena or clickhouse or openpyxl or pyarrow or project or sqlite or aws_creds ?
3.9 aws_deps ?
3.9 big ?
3.9 databricks ?
3.9 filesystem ?
3.9 mssql ?
3.9 mysql ?
3.9 postgresql ?
3.9 snowflake ?
3.9 spark ?
3.9 trino ?
cloud 0.00% <ø> (ø)
docs-basic 54.47% <ø> (+<0.01%) ⬆️
docs-creds-needed 55.05% <ø> (+<0.01%) ⬆️
docs-spark 54.57% <ø> (+<0.01%) ⬆️

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
Member

@jcampbell jcampbell left a comment

Choose a reason for hiding this comment

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

I did some word smithing on several of these, but I think there's a general issue that's worth tackling first...how do we want to describe the abstract concepts here that are part of configuration. We've got "object" "reference" "python class" "storage location"

I think the structure is hampering us a bit here. What if instead of A XXXX where XXXX is one of hte above, we were more descriptive, along the lines of...

Data Context: A Data Context stores all of the configuration for a project in Great Expectations, and provides an API to access each of the objects.

docs/docusaurus/docs/reference/learn/glossary.md Outdated Show resolved Hide resolved
docs/docusaurus/docs/reference/learn/glossary.md Outdated Show resolved Hide resolved
docs/docusaurus/docs/reference/learn/glossary.md Outdated Show resolved Hide resolved
docs/docusaurus/docs/reference/learn/glossary.md Outdated Show resolved Hide resolved
docs/docusaurus/docs/reference/learn/glossary.md Outdated Show resolved Hide resolved
Rachel-Reverie and others added 2 commits April 5, 2024 11:48
Co-authored-by: James Campbell <james@greatexpectations.io>
Co-authored-by: James Campbell <james@greatexpectations.io>
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.

None yet

2 participants