great-expectations / great_expectations

Always know what to expect from your data.
https://docs.greatexpectations.io/
Apache License 2.0
10.01k stars 1.55k forks source link

[DOCS] SUJ-E #10665

Open klavavej opened 1 week ago

klavavej commented 1 week ago

Resolves https://greatexpectations.atlassian.net/browse/DOC-931 - updates docs according to the plan linked in that issue. This PR addresses all of the "Must" items but not all of the "Should"/"Could" items. I will file a follow-up issue for remaining "Should"/"Could" items.

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!

netlify[bot] commented 1 week ago

Deploy Preview for niobium-lead-7998 ready!

Name Link
Latest commit 0d55698769c339c3ae038dde66a3e877aaf110af
Latest deploy log https://app.netlify.com/sites/niobium-lead-7998/deploys/673dfb190520da0008a61cc9
Deploy Preview https://deploy-preview-10665.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.

codecov[bot] commented 1 week ago

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Project coverage is 80.47%. Comparing base (6f523d5) to head (0d55698).

:white_check_mark: All tests successful. No failed tests found.

Additional details and impacted files ```diff @@ Coverage Diff @@ ## develop #10665 +/- ## ======================================== Coverage 80.47% 80.47% ======================================== Files 462 462 Lines 40106 40106 ======================================== Hits 32277 32277 Misses 7829 7829 ``` | [Flag](https://app.codecov.io/gh/great-expectations/great_expectations/pull/10665/flags?src=pr&el=flags&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=great-expectations) | Coverage Δ | | |---|---|---| | [3.10](https://app.codecov.io/gh/great-expectations/great_expectations/pull/10665/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=great-expectations) | `68.17% <ø> (ø)` | | | [3.10 athena or openpyxl or pyarrow or project or sqlite or aws_creds](https://app.codecov.io/gh/great-expectations/great_expectations/pull/10665/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=great-expectations) | `?` | | | [3.10 aws_deps](https://app.codecov.io/gh/great-expectations/great_expectations/pull/10665/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=great-expectations) | `?` | | | [3.10 big](https://app.codecov.io/gh/great-expectations/great_expectations/pull/10665/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=great-expectations) | `?` | | | [3.10 bigquery](https://app.codecov.io/gh/great-expectations/great_expectations/pull/10665/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=great-expectations) | `?` | | | [3.10 clickhouse](https://app.codecov.io/gh/great-expectations/great_expectations/pull/10665/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=great-expectations) | `?` | | | [3.10 filesystem](https://app.codecov.io/gh/great-expectations/great_expectations/pull/10665/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=great-expectations) | `?` | | | [3.10 mssql](https://app.codecov.io/gh/great-expectations/great_expectations/pull/10665/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=great-expectations) | `?` | | | [3.10 mysql](https://app.codecov.io/gh/great-expectations/great_expectations/pull/10665/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=great-expectations) | `?` | | | [3.10 postgresql](https://app.codecov.io/gh/great-expectations/great_expectations/pull/10665/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=great-expectations) | `?` | | | [3.10 spark_connect](https://app.codecov.io/gh/great-expectations/great_expectations/pull/10665/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=great-expectations) | `?` | | | [3.11](https://app.codecov.io/gh/great-expectations/great_expectations/pull/10665/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=great-expectations) | `68.17% <ø> (ø)` | | | [3.11 athena or openpyxl or pyarrow or project or sqlite or aws_creds](https://app.codecov.io/gh/great-expectations/great_expectations/pull/10665/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=great-expectations) | `?` | | | [3.11 aws_deps](https://app.codecov.io/gh/great-expectations/great_expectations/pull/10665/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=great-expectations) | `?` | | | [3.11 big](https://app.codecov.io/gh/great-expectations/great_expectations/pull/10665/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=great-expectations) | `?` | | | [3.11 bigquery](https://app.codecov.io/gh/great-expectations/great_expectations/pull/10665/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=great-expectations) | `?` | | | [3.11 clickhouse](https://app.codecov.io/gh/great-expectations/great_expectations/pull/10665/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=great-expectations) | `?` | | | [3.11 filesystem](https://app.codecov.io/gh/great-expectations/great_expectations/pull/10665/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=great-expectations) | `?` | | | [3.11 mssql](https://app.codecov.io/gh/great-expectations/great_expectations/pull/10665/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=great-expectations) | `?` | | | [3.11 mysql](https://app.codecov.io/gh/great-expectations/great_expectations/pull/10665/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=great-expectations) | `?` | | | [3.11 postgresql](https://app.codecov.io/gh/great-expectations/great_expectations/pull/10665/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=great-expectations) | `?` | | | [3.11 spark_connect](https://app.codecov.io/gh/great-expectations/great_expectations/pull/10665/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=great-expectations) | `?` | | | [3.12](https://app.codecov.io/gh/great-expectations/great_expectations/pull/10665/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=great-expectations) | `68.15% <ø> (ø)` | | | [3.12 athena or openpyxl or pyarrow or project or sqlite or aws_creds](https://app.codecov.io/gh/great-expectations/great_expectations/pull/10665/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=great-expectations) | `55.49% <ø> (ø)` | | | [3.12 aws_deps](https://app.codecov.io/gh/great-expectations/great_expectations/pull/10665/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=great-expectations) | `46.14% <ø> (ø)` | | | [3.12 big](https://app.codecov.io/gh/great-expectations/great_expectations/pull/10665/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=great-expectations) | `54.74% <ø> (ø)` | | | [3.12 bigquery](https://app.codecov.io/gh/great-expectations/great_expectations/pull/10665/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=great-expectations) | `45.91% <ø> (ø)` | | | [3.12 databricks](https://app.codecov.io/gh/great-expectations/great_expectations/pull/10665/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=great-expectations) | `48.12% <ø> (ø)` | | | [3.12 filesystem](https://app.codecov.io/gh/great-expectations/great_expectations/pull/10665/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=great-expectations) | `61.70% <ø> (ø)` | | | [3.12 mssql](https://app.codecov.io/gh/great-expectations/great_expectations/pull/10665/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=great-expectations) | `51.52% <ø> (ø)` | | | [3.12 mysql](https://app.codecov.io/gh/great-expectations/great_expectations/pull/10665/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=great-expectations) | `51.58% <ø> (ø)` | | | [3.12 postgresql](https://app.codecov.io/gh/great-expectations/great_expectations/pull/10665/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=great-expectations) | `54.64% <ø> (ø)` | | | [3.12 snowflake](https://app.codecov.io/gh/great-expectations/great_expectations/pull/10665/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=great-expectations) | `48.89% <ø> (ø)` | | | [3.12 spark](https://app.codecov.io/gh/great-expectations/great_expectations/pull/10665/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=great-expectations) | `58.08% <ø> (ø)` | | | [3.12 spark_connect](https://app.codecov.io/gh/great-expectations/great_expectations/pull/10665/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=great-expectations) | `46.44% <ø> (ø)` | | | [3.12 trino](https://app.codecov.io/gh/great-expectations/great_expectations/pull/10665/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=great-expectations) | `52.67% <ø> (ø)` | | | [3.9](https://app.codecov.io/gh/great-expectations/great_expectations/pull/10665/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=great-expectations) | `68.20% <ø> (ø)` | | | [3.9 athena or openpyxl or pyarrow or project or sqlite or aws_creds](https://app.codecov.io/gh/great-expectations/great_expectations/pull/10665/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=great-expectations) | `55.50% <ø> (ø)` | | | [3.9 aws_deps](https://app.codecov.io/gh/great-expectations/great_expectations/pull/10665/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=great-expectations) | `46.16% <ø> (ø)` | | | [3.9 big](https://app.codecov.io/gh/great-expectations/great_expectations/pull/10665/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=great-expectations) | `54.75% <ø> (ø)` | | | [3.9 bigquery](https://app.codecov.io/gh/great-expectations/great_expectations/pull/10665/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=great-expectations) | `45.92% <ø> (ø)` | | | [3.9 clickhouse](https://app.codecov.io/gh/great-expectations/great_expectations/pull/10665/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=great-expectations) | `43.03% <ø> (ø)` | | | [3.9 databricks](https://app.codecov.io/gh/great-expectations/great_expectations/pull/10665/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=great-expectations) | `48.14% <ø> (ø)` | | | [3.9 filesystem](https://app.codecov.io/gh/great-expectations/great_expectations/pull/10665/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=great-expectations) | `61.72% <ø> (ø)` | | | [3.9 mssql](https://app.codecov.io/gh/great-expectations/great_expectations/pull/10665/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=great-expectations) | `51.50% <ø> (ø)` | | | [3.9 mysql](https://app.codecov.io/gh/great-expectations/great_expectations/pull/10665/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=great-expectations) | `51.57% <ø> (ø)` | | | [3.9 postgresql](https://app.codecov.io/gh/great-expectations/great_expectations/pull/10665/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=great-expectations) | `54.63% <ø> (ø)` | | | [3.9 snowflake](https://app.codecov.io/gh/great-expectations/great_expectations/pull/10665/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=great-expectations) | `48.91% <ø> (ø)` | | | [3.9 spark](https://app.codecov.io/gh/great-expectations/great_expectations/pull/10665/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=great-expectations) | `58.04% <ø> (ø)` | | | [3.9 spark_connect](https://app.codecov.io/gh/great-expectations/great_expectations/pull/10665/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=great-expectations) | `46.45% <ø> (ø)` | | | [3.9 trino](https://app.codecov.io/gh/great-expectations/great_expectations/pull/10665/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=great-expectations) | `52.66% <ø> (ø)` | | | [cloud](https://app.codecov.io/gh/great-expectations/great_expectations/pull/10665/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=great-expectations) | `0.00% <ø> (ø)` | | | [docs-basic](https://app.codecov.io/gh/great-expectations/great_expectations/pull/10665/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=great-expectations) | `53.81% <ø> (ø)` | | | [docs-creds-needed](https://app.codecov.io/gh/great-expectations/great_expectations/pull/10665/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=great-expectations) | `52.97% <ø> (ø)` | | | [docs-spark](https://app.codecov.io/gh/great-expectations/great_expectations/pull/10665/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=great-expectations) | `52.45% <ø> (ø)` | | Flags with carried forward coverage won't be shown. [Click here](https://docs.codecov.io/docs/carryforward-flags?utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=great-expectations#carryforward-flags-in-the-pull-request-comment) to find out more.

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.


🚨 Try these New Features: