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.

Sign up for GitHub

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

Jump to bottom

[DOCS] GX Cloud Content Adjustments #9746

Merged
merged 5 commits into from
Apr 15, 2024
Merged

[DOCS] GX Cloud Content Adjustments #9746

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
e3cbd78
Preliminary edits.
kwcanuck Apr 12, 2024
3d74cd1
Updated annotation.
kwcanuck Apr 12, 2024
278f024
Link fix.
kwcanuck Apr 12, 2024
11dd4bb
Merge branch 'develop' into intro-fix
kwcanuck Apr 12, 2024
ed8c91b
Added edits requested after SME review.
kwcanuck Apr 15, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
2 changes: 2 additions & 0 deletions docs/docusaurus/docs/cloud/connect/connect_python.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,8 @@ Learn how to use GX Cloud from a Python script or interpreter, such as a Jupyter

To get the most out of GX Cloud, GX recommends deploying the GX Agent. If you do not deploy the GX Agent, some features and functionality might be unavailable. To deploy the GX Agent, see [Deploy the GX Agent](../deploy_gx_agent.md).

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 [Manage Data Sources](/core/manage_and_access_data/manage_data_sources.md).

:::

## Prerequisites
Expand Down
6 changes: 1 addition & 5 deletions docs/docusaurus/docs/cloud/deploy_gx_agent.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 try 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).
kwcanuck marked this conversation as resolved.
Show resolved Hide resolved

## Prerequisites

Expand Down Expand Up @@ -71,10 +71,6 @@ Use the information provided here to view your organization ID or create a new a

The GX Agent allows you to securely access your data without connecting to it or interacting with it directly. To learn more about the GX Agent and deployment patterns, see [About GX Cloud](./about_gx.md).

### Self-hosted and org-hosted deployments

To try 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. A self-hosted deployment is recommended when you want to test GX Cloud features and functionality, and it differs from the recommended [org-hosted deployment](./about_gx.md#org-hosted-deployment-pattern), in which the GX Agent runs in your organization's deployment environment.

### Prerequisites

- You have a GX Cloud access token and organization ID. See [Get your access token and organization ID](#get-your-access-token-and-organization-id).
Expand Down
2 changes: 2 additions & 0 deletions docs/docusaurus/versioned_docs/version-0.18/cloud/connect/connect_python.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,8 @@ Learn how to use GX Cloud from a Python script or interpreter, such as a Jupyter

To get the most out of GX Cloud, GX recommends deploying the GX Agent. If you do not deploy the GX Agent, some features and functionality might be unavailable. To deploy the GX Agent, see [Deploy the GX Agent](../deploy_gx_agent.md).

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

Comment on lines +18 to +19
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

:::

## Prerequisites
Expand Down
10 changes: 2 additions & 8 deletions docs/docusaurus/versioned_docs/version-0.18/cloud/deploy_gx_agent.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 try 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).

## Prerequisites

Expand Down Expand Up @@ -71,10 +71,6 @@ Use the information provided here to view your organization ID or create a new a

The GX Agent allows you to securely access your data without connecting to it or interacting with it directly. To learn more about the GX Agent and deployment patterns, see [About GX Cloud](./about_gx.md).

### Self-hosted and org-hosted deployments

To try 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. A self-hosted deployment is recommended when you want to test GX Cloud features and functionality, and it differs from the recommended [org-hosted deployment](./about_gx.md#org-hosted-deployment-pattern), in which the GX Agent runs in your organization's deployment environment.

### Prerequisites

- You have a GX Cloud access token and organization ID. See [Get your access token and organization ID](#get-your-access-token-and-organization-id).
Expand Down Expand Up @@ -234,6 +230,7 @@ You can deploy the GX Agent in any environment in which you create Kubernetes cl
</TabItem>
</Tabs>


## Next steps

Want to continue testing GX Cloud features and functionality?
Expand All @@ -243,6 +240,3 @@ Want to continue testing GX Cloud features and functionality?
Ready to connect GX Cloud to your deployment environment?

- [Connect GX Cloud](./connect/connect_lp.md)