Skip to content

[DOCS] WIP: Creating a different docusaurus instance for GX Cloud #10617

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

Open
wants to merge 6 commits into
base: develop
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -15,9 +15,9 @@ Apache Airflow is an orchestration tool that allows you to schedule and monitor

- You have installed Apache Airflow and initialized the database (__airflow db init__).

- You have [connected GX Cloud to a Data Asset on a Data Source](/cloud/data_assets/manage_data_assets.md#create-a-data-asset).
- You have [connected GX Cloud to a Data Asset on a Data Source](/data_assets/manage_data_assets.md#create-a-data-asset).

- You have [created an Expectation Suite](/cloud/expectation_suites/manage_expectation_suites.md) and [added Expectations](/cloud/expectations/manage_expectations.md#create-an-expectation).
- You have [created an Expectation Suite](/expectation_suites/manage_expectation_suites.md) and [added Expectations](/expectations/manage_expectations.md#create-an-expectation).


## Run Airflow Standalone to create a fresh local Airflow environment
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ import Tabs from '@theme/Tabs';

## Prerequisites

- You have a [GX Cloud account](https://greatexpectations.io/cloud) with [Admin or Editor permissions](/cloud/users/manage_users.md#roles-and-responsibilities).
- You have a [GX Cloud account](https://greatexpectations.io/cloud) with [Admin or Editor permissions](/users/manage_users.md#roles-and-responsibilities).

- You have a Databricks SQL catalog, schema, and table.

Expand Down Expand Up @@ -39,4 +39,4 @@ import Tabs from '@theme/Tabs';

6. Click **Add Asset**.

7. Create an Expectation. See [Create an Expectation](/cloud/expectations/manage_expectations.md#create-an-expectation).
7. Create an Expectation. See [Create an Expectation](/expectations/manage_expectations.md#create-an-expectation).
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ import Tabs from '@theme/Tabs';

## Prerequisites

- You have a [GX Cloud account](https://greatexpectations.io/cloud) with [Admin or Editor permissions](/cloud/users/manage_users.md#roles-and-responsibilities).
- You have a [GX Cloud account](https://greatexpectations.io/cloud) with [Admin or Editor permissions](/users/manage_users.md#roles-and-responsibilities).

- You have a PostgreSQL database, schema, and table.

Expand Down Expand Up @@ -59,5 +59,5 @@ import Tabs from '@theme/Tabs';

11. Click **Finish**.

12. Create an Expectation. See [Create an Expectation](/cloud/expectations/manage_expectations.md#create-an-expectation).
12. Create an Expectation. See [Create an Expectation](/expectations/manage_expectations.md#create-an-expectation).

Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,7 @@ Environment variables securely store your GX Cloud access credentials.
```

:::note
After you save your **GX_CLOUD_ACCESS_TOKEN** and **GX_CLOUD_ORGANIZTION_ID**, you can use Python scripts to access GX Cloud and complete other tasks. See the [GX Core guides](/core/introduction/introduction.mdx).
After you save your **GX_CLOUD_ACCESS_TOKEN** and **GX_CLOUD_ORGANIZTION_ID**, you can use Python scripts to access GX Cloud and complete other tasks. See the [GX Core guides](/docs/core/introduction).
:::

2. Optional. If you created a temporary file to record your user access token and Organization ID, delete it.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ import Tabs from '@theme/Tabs';

## Prerequisites

- You have a [GX Cloud account](https://greatexpectations.io/cloud) with [Admin or Editor permissions](/cloud/users/manage_users.md#roles-and-responsibilities).
- You have a [GX Cloud account](https://greatexpectations.io/cloud) with [Admin or Editor permissions](/users/manage_users.md#roles-and-responsibilities).

- You have a Snowflake database, schema, and table.

Expand Down Expand Up @@ -83,4 +83,4 @@ You can use an existing Snowflake warehouse, but GX recommends creating a separa

12. Click **Finish**.

13. Create an Expectation. See [Create an Expectation](/cloud/expectations/manage_expectations.md#create-an-expectation).
13. Create an Expectation. See [Create an Expectation](/expectations/manage_expectations.md#create-an-expectation).
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ A Data Asset is a collection of records that you create when you connect to your

## Create a Data Asset

Create a Data Asset to define the data you want GX Cloud to access. To connect to Data Assets for a Data Source not currently available in GX Cloud, see [Connect to data](/core/connect_to_data/connect_to_data.md) in the GX Core documentation.
Create a Data Asset to define the data you want GX Cloud to access. To connect to Data Assets for a Data Source not currently available in GX Cloud, see [Connect to data](/core/connect_to_data/) in the GX Core documentation.

<Tabs
groupId="manage-data-assets"
Expand Down Expand Up @@ -47,7 +47,7 @@ Define the data you want GX Cloud to access within Snowflake.

3. Select one of the following options:

- If you're connecting to an org-hosted Snowflake Data Asset for the first time, copy the code and see [Connect GX Cloud to Snowflake](../connect/connect_snowflake.md).
- If you're connecting to an org-hosted Snowflake Data Asset for the first time, copy the code and see [Connect GX Cloud to Snowflake](/connect/connect_snowflake.md).

- If you're testing GX Cloud features and functionality in a self-hosted environment, click **I have created a GX Cloud user with valid permissions** and then click **Continue**.

Expand Down Expand Up @@ -89,7 +89,7 @@ Define the data you want GX Cloud to access within Snowflake.

9. Click **Add Asset**.

10. Create an Expectation. See [Create an Expectation](/cloud/expectations/manage_expectations.md#create-an-expectation).
10. Create an Expectation. See [Create an Expectation](/expectations/manage_expectations.md#create-an-expectation).

</TabItem>
<TabItem value="PostgreSQL">
Expand All @@ -114,7 +114,7 @@ Define the data you want GX Cloud to access within PostgreSQL.

3. Select one of the following options:

- If you're connecting to an org-hosted PostgreSQL Data Asset for the first time, copy the code and see [Connect GX Cloud to PostgreSQL](../connect/connect_postgresql.md).
- If you're connecting to an org-hosted PostgreSQL Data Asset for the first time, copy the code and see [Connect GX Cloud to PostgreSQL](/connect/connect_postgresql.md).

- If you're testing GX Cloud features and functionality in a self-hosted environment, click **I have created a GX Cloud user with valid permissions** and then click **Continue**.

Expand All @@ -137,7 +137,7 @@ Define the data you want GX Cloud to access within PostgreSQL.

8. Click **Add Asset**.

9. Create an Expectation. See [Create an Expectation](/cloud/expectations/manage_expectations.md#create-an-expectation).
9. Create an Expectation. See [Create an Expectation](/expectations/manage_expectations.md#create-an-expectation).

</TabItem>
</Tabs>
Expand Down Expand Up @@ -198,7 +198,7 @@ When you create an Expectation after fetching metrics for a Data Asset, the colu

- To add an Expectation to an existing Expectation Suite, click the **Existing Suite** tab and then select an existing Expectation Suite.

6. Select an Expectation type. See [Available Expectation types](/cloud/expectations/manage_expectations.md#available-expectation-types).
6. Select an Expectation type. See [Available Expectation types](/expectations/manage_expectations.md#available-expectation-types).

7. Complete the fields in the **Create Expectation** pane.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ import TabItem from '@theme/TabItem';
import Tabs from '@theme/Tabs';


The GX Agent is used to run an [agent-enabled deployment](/cloud/deploy/deployment_patterns.md#agent-enabled-deployment) of GX Cloud. If you are running a fully-hosted or read-only deployment, you do not need to deploy the GX Agent.
The GX Agent is used to run an [agent-enabled deployment](deployment_patterns.md#agent-enabled-deployment) of GX Cloud. If you are running a fully-hosted or read-only deployment, you do not need to deploy the GX Agent.

:::info Enable the GX Agent

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ GX Cloud deployment patterns are defined by how GX Cloud connects to your data.

In a fully-hosted deployment, GX Cloud connects directly to your organization's data using a cloud-to-cloud connection. Connection to your data is read-only and uses encrypted communication. Fully-hosted deployments are the quickest way to get started with GX Cloud.

![GX Cloud fully-hosted deployment](./deployment_images/fully_hosted_deployment.png)
![GX Cloud fully-hosted deployment](deployment_images/fully_hosted_deployment.png)

If you are using a fully-hosted deployment, ensure that the following GX Cloud IPs are in your organization's allow list for ingress traffic.
- `44.209.54.123`
Expand All @@ -30,9 +30,9 @@ If you are using a fully-hosted deployment, ensure that the following GX Cloud I

In an agent-enabled deployment, the GX Agent runs in your environment and serves as an intermediary between GX Cloud and your data. GX Cloud sends jobs to the GX Agent, the GX Agent connects to and interacts with your data, and the GX Agent reports job results back to GX Cloud.

![GX Cloud agent-enabled deployment](./deployment_images/agent_enabled_deployment.png)
![GX Cloud agent-enabled deployment](deployment_images/agent_enabled_deployment.png)

The GX Agent is a Docker container that can be run in your organization's deployment environment or locally. See [Deploy the GX Agent](/cloud/deploy/deploy_gx_agent.md) for setup details.
The GX Agent is a Docker container that can be run in your organization's deployment environment or locally. See [Deploy the GX Agent](deploy_gx_agent.md) for setup details.


## Read-only deployment
Expand All @@ -41,4 +41,4 @@ In a read-only deployment, you use the GX Core Python library to push GX metadat

In this deployment scenario, there is a one-way flow of information from your environment to GX Cloud.

![GX Cloud read-only deployment](./deployment_images/read_only_deployment.png)
![GX Cloud read-only deployment](deployment_images/read_only_deployment.png)
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ Expectation Suites contain multiple Expectations for a single Data Asset. Like E

## Prerequisites

- You have a [Data Asset](/cloud/data_assets/manage_data_assets.md#create-a-data-asset).
- You have a [Data Asset](/data_assets/manage_data_assets.md#create-a-data-asset).

## Create an Expectation Suite

Expand All @@ -26,9 +26,9 @@ If you have specific business requirements, or you want to examine specific data

5. Click **Create**.

7. Add Expectations to the Expectation Suite. See [Create an Expectation](/cloud/expectations/manage_expectations.md#create-an-expectation).
7. Add Expectations to the Expectation Suite. See [Create an Expectation](/expectations/manage_expectations.md#create-an-expectation).

8. Optional. Run a Validation on the Expectation Suite. See [Run a Validation](/cloud/validations/manage_validations.md#run-a-validation).
8. Optional. Run a Validation on the Expectation Suite. See [Run a Validation](/validations/manage_validations.md#run-a-validation).

## Edit an Expectation Suite

Expand All @@ -54,6 +54,6 @@ If you have specific business requirements, or you want to examine specific data

## Related documentation

- [Manage Expectations](../expectations/manage_expectations.md)
- [Manage Expectations](/expectations/manage_expectations.md)

- [Manage Validations](../validations/manage_validations.md)
- [Manage Validations](/validations/manage_validations.md)
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ An Expectation is a verifiable assertion about your data. They make implicit ass

## Prerequisites

- You have a [Data Asset](/cloud/data_assets/manage_data_assets.md#create-a-data-asset).
- You have a [Data Asset](/data_assets/manage_data_assets.md#create-a-data-asset).

## Available Expectations

Expand Down Expand Up @@ -98,7 +98,7 @@ When you select your `n` run count, and:
- There are `>n` runs, the Expectation will take the last `n` runs into account.


![GX Cloud dynamic parameters](./expectation_images/dynamic_parameters.png)
![GX Cloud dynamic parameters](expectation_images/dynamic_parameters.png)


## Add an Expectation
Expand Down Expand Up @@ -129,7 +129,7 @@ When you select your `n` run count, and:

8. Click **Save** or click **Save & Add More** and then repeat steps 5 and 7 to add additional Expectations.

9. Optional. Run a Validation. See [Run a Validation](/cloud/validations/manage_validations.md#run-a-validation).
9. Optional. Run a Validation. See [Run a Validation](/validations/manage_validations.md#run-a-validation).

## Edit an Expectation

Expand Down Expand Up @@ -173,4 +173,4 @@ View the Expectation history to determine when an Expectation was changed and wh

## Related documentation

- [Manage Expectation Suites](../expectation_suites/manage_expectation_suites.md)
- [Manage Expectation Suites](/expectation_suites/manage_expectation_suites.md)
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ GX Cloud data validation workflows are created using GX Cloud components, entiti

A GX Cloud data validation workflow can be implemented using the following steps:

![Standard GX Cloud workflow](./overview_images/gx_cloud_workflow.png)
![Standard GX Cloud workflow](overview_images/gx_cloud_workflow.png)

1. Connect to your data.
2. Create a Data Asset.
Expand All @@ -40,15 +40,15 @@ A GX Cloud data validation workflow can be implemented using the following steps
### Additional workflow features
There are a variety of GX Cloud features that support additional enhancements to your GX Cloud data validation workflow.

![GX Cloud workflow enhanced with product features](./overview_images/gx_cloud_workflow_enhanced.png)
![GX Cloud workflow enhanced with product features](overview_images/gx_cloud_workflow_enhanced.png)

* **GX Cloud user management.** GX Cloud functions as a shared portal to manage and monitor your organization's data quality. Users can be invited to your GX Cloud organization and assigned a role that governs their ability to view and edit components and workflows in GX Cloud. See [Manage users and access tokens](/cloud/users/manage_users.md) for more details.
* **GX Cloud user management.** GX Cloud functions as a shared portal to manage and monitor your organization's data quality. Users can be invited to your GX Cloud organization and assigned a role that governs their ability to view and edit components and workflows in GX Cloud. See [Manage users and access tokens](/users/manage_users.md) for more details.

* **Data Asset profiling.** GX Cloud introspects your data schema by default on Data Asset creation, and also offers one-click fetching of additional descriptive metrics including column type and statistical summaries. Data profiling results are used to suggest parameters for Expectations that you create.

* **Schedule Validations.** GX Cloud enables you to schedule validations, so that you can test and assess your data on a regular cadence and monitor data quality over time. See [Manage schedules](/cloud/schedules/manage_schedules.md) for more detail.
* **Schedule Validations.** GX Cloud enables you to schedule validations, so that you can test and assess your data on a regular cadence and monitor data quality over time. See [Manage schedules](/schedules/manage_schedules.md) for more detail.

* **Alerting.** GX Cloud provides the ability to send alerts when validations fail, enabling your organization to remain proactively aware of the health of your Data Assets. See [Manage alerts](/cloud/alerts/manage_alerts.md) for more detail.
* **Alerting.** GX Cloud provides the ability to send alerts when validations fail, enabling your organization to remain proactively aware of the health of your Data Assets. See [Manage alerts](/alerts/manage_alerts.md) for more detail.



Expand All @@ -57,12 +57,12 @@ There are a variety of GX Cloud features that support additional enhancements to

GX Cloud architecture comprises a frontend web UI, storage for entity configuration and metadata, a backend application, and a Python client.

![GX Cloud architecture](./overview_images/gx_cloud_architecture.png)
![GX Cloud architecture](overview_images/gx_cloud_architecture.png)

* **GX Cloud frontend web UI**. Enables you to manage and validate your organization's data quality without running code and provides shared visibility into your organization's Validation Results history. The GX Cloud web UI is browser- and platform-independent.

* **GX Cloud data storage**. Stores the configurations for your organization's Data Sources, Data Assets, Expectations, and Validations alongside your organization's Validation Result histories and Data Asset descriptive metrics.

* **GX Cloud backend application**. Contains the necessary logic and compute to connect to data and run queries. The specifics of how the GX Cloud backend connects to your data is described in [Deployment patterns](/cloud/deploy/deployment_patterns.md).
* **GX Cloud backend application**. Contains the necessary logic and compute to connect to data and run queries. The specifics of how the GX Cloud backend connects to your data is described in [Deployment patterns](/deploy/deployment_patterns.md).

* **GX Core Python client**. Enables you to interact programmatically with the GX Cloud backend application. The [GX Core Python client](/core/introduction/introduction.mdx) can complement and extend your web UI-created workflows.
* **GX Core Python client**. Enables you to interact programmatically with the GX Cloud backend application. The [GX Core Python client](/docs/core/introduction) can complement and extend your web UI-created workflows.
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ When you run a validation on an Expectation, a Checkpoint is added. The Checkpoi

## Prerequisites

- You have created an [Expectation](/cloud/expectations/manage_expectations.md#create-an-expectation).
- You have created an [Expectation](/expectations/manage_expectations.md#create-an-expectation).

## Run a Validation

Expand Down
8 changes: 4 additions & 4 deletions docs/docusaurus/docs/application_integration_support.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,10 +40,10 @@ The following table defines the GX Cloud, GX Core, and Community Supported integ

The following table defines the GX components supported by GX Cloud and GX Core.

| Component | GX Cloud | GX Core | Community |
| ------------ | ----------------------------------------------------------------------------------------------- | --------------------------------------------------------------------- | -------------------------------------------------------------------------- |
| Expectations | See [Available Expectations](/cloud/expectations/manage_expectations.md#available-expectations) | See [Expectations Gallery](https://greatexpectations.io/expectations) | See [Legacy Gallery](https://greatexpectations.io/legacy/v1/expectations/) |
| GX Agent | All versions | N/A | N/A |
| Component | GX Cloud | GX Core | Community |
| ------------ | -------------------------------------------------------------------------------------------- | --------------------------------------------------------------------- | -------------------------------------------------------------------------- |
| Expectations | See [Available Expectations](/cloud/expectations/manage_expectations#available-expectations) | See [Expectations Gallery](https://greatexpectations.io/expectations) | See [Legacy Gallery](https://greatexpectations.io/legacy/v1/expectations/) |
| GX Agent | All versions | N/A | N/A |

### Operating systems

Expand Down
Loading
Loading