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] GX Cloud Content Adjustments #9746

Merged
merged 5 commits into from Apr 15, 2024
Merged

[DOCS] GX Cloud Content Adjustments #9746

merged 5 commits into from Apr 15, 2024

Conversation

kwcanuck
Copy link
Contributor

@kwcanuck kwcanuck commented Apr 12, 2024

In this Slack conversation @Shinnnyshinshin and @annabarr discussed the consolidation and edit of the content in the Self-hosted and org-hosted deployments . In a separate Slack conversation, there was a request to update the annotation in Connect to GX Cloud with Python to clarify what should be done when a user doesn't want to deploy the GX Agent. This PR implements the requested changes.

Definition of done

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

Copy link

netlify bot commented Apr 12, 2024

Deploy Preview for niobium-lead-7998 ready!

Name Link
🔨 Latest commit ed8c91b
🔍 Latest deploy log https://app.netlify.com/sites/niobium-lead-7998/deploys/661d2b21f27d4e0009f37663
😎 Deploy Preview https://deploy-preview-9746.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 12, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 82.68%. Comparing base (aec14be) to head (ed8c91b).
Report is 8 commits behind head on develop.

Additional details and impacted files
@@             Coverage Diff             @@
##           develop    #9746      +/-   ##
===========================================
+ Coverage    82.66%   82.68%   +0.02%     
===========================================
  Files          512      512              
  Lines        46671    46896     +225     
===========================================
+ Hits         38579    38777     +198     
- Misses        8092     8119      +27     
Flag Coverage Δ
3.10 65.03% <ø> (+0.12%) ⬆️
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 65.03% <ø> (+0.12%) ⬆️
3.11 athena or clickhouse or openpyxl or pyarrow or project or sqlite or aws_creds 53.74% <ø> (-0.14%) ⬇️
3.11 aws_deps 48.84% <ø> (-0.12%) ⬇️
3.11 big 63.94% <ø> (-0.19%) ⬇️
3.11 databricks 48.03% <ø> (-0.12%) ⬇️
3.11 filesystem 63.72% <ø> (-0.08%) ⬇️
3.11 mssql 47.25% <ø> (-0.11%) ⬇️
3.11 mysql 47.30% <ø> (-0.11%) ⬇️
3.11 postgresql 54.02% <ø> (-0.14%) ⬇️
3.11 snowflake 48.56% <ø> (-0.12%) ⬇️
3.11 spark 60.42% <ø> (-0.15%) ⬇️
3.11 trino 53.66% <ø> (-0.14%) ⬇️
3.8 65.04% <ø> (+0.12%) ⬆️
3.8 athena or clickhouse or openpyxl or pyarrow or project or sqlite or aws_creds 53.75% <ø> (-0.14%) ⬇️
3.8 aws_deps 48.85% <ø> (-0.12%) ⬇️
3.8 big 63.94% <ø> (-0.19%) ⬇️
3.8 databricks 48.04% <ø> (-0.12%) ⬇️
3.8 filesystem 63.72% <ø> (-0.08%) ⬇️
3.8 mssql 47.23% <ø> (-0.11%) ⬇️
3.8 mysql 47.28% <ø> (-0.11%) ⬇️
3.8 postgresql 54.01% <ø> (-0.14%) ⬇️
3.8 snowflake 48.57% <ø> (-0.12%) ⬇️
3.8 spark 60.38% <ø> (-0.15%) ⬇️
3.8 trino 53.65% <ø> (-0.14%) ⬇️
3.9 65.04% <ø> (+0.12%) ⬆️
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.30% <ø> (-0.14%) ⬇️
docs-creds-needed 54.87% <ø> (-0.14%) ⬇️
docs-spark 54.40% <ø> (-0.14%) ⬇️

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

@Rachel-Reverie Rachel-Reverie left a comment

Choose a reason for hiding this comment

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

LGTM

@kwcanuck kwcanuck requested a review from annabarr April 15, 2024 13:39
Comment on lines +18 to +19
If you don't want to deploy the GX Agent, use the GX API to create a Data Source for your GX Cloud organization. See [Connect to a Data Source](/oss/guides/connecting_to_your_data/connect_to_data_lp.md).

Copy link
Contributor

Choose a reason for hiding this comment

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

Love this clarity. Thanks

@@ -12,7 +12,7 @@ import Tabs from '@theme/Tabs';

To use GX Cloud features and functionality, you need to deploy the GX Agent. The GX Agent is an intermediary between GX Cloud and your organization's data stores. GX Cloud does not connect directly to your data, all data access occurs within the GX Agent. GX Cloud sends jobs to the GX Agent, the GX Agent executes these jobs against your data, and then sends the job results to GX Cloud.

The GX Agent is typically deployed in your organization's deployment environment, for example, in a development, staging, or production cloud services environment. The GX Agent serves all GX Cloud users within your organization. It can be run as part of your development or production workflows. To learn more about the GX Agent and deployment patterns, see [About GX Cloud](./about_gx.md).
To test GX Cloud, you use a [self-hosted deployment](./about_gx#self-hosted-deployment-pattern) to run the GX Agent with Docker, connect the GX Agent to your target Data Sources, and use the GX Cloud web UI to define your Data Assets, create Expectations, and run Validations. When you've finished testing GX Cloud, you move to an [org-hosted deployment](./about_gx.md#org-hosted-deployment-pattern) and deploy the GX Agent to your organization's development, staging, or production cloud services environment. The GX Agent serves all GX Cloud users within your organization. It can be run as part of your development or production workflows. To learn more about the GX Agent and deployment patterns, see [About GX Cloud](./about_gx.md).
Copy link
Contributor

Choose a reason for hiding this comment

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

🚀

Copy link
Contributor

@Shinnnyshinshin Shinnnyshinshin left a comment

Choose a reason for hiding this comment

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

Thank you so much for this update @kwcanuck LGTM

Copy link

@annabarr annabarr left a comment

Choose a reason for hiding this comment

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

lgtm!

@kwcanuck kwcanuck added this pull request to the merge queue Apr 15, 2024
Merged via the queue into develop with commit 8ccc5f6 Apr 15, 2024
64 checks passed
@kwcanuck kwcanuck deleted the intro-fix branch April 15, 2024 16:57
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

4 participants