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] Remove Prerequisites from Admonitions #7786

Merged
merged 13 commits into from
May 2, 2023
24 changes: 10 additions & 14 deletions docs/docusaurus/docs/components/_prerequisites.jsx
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
import React from 'react'
import Admonition from '@theme/Admonition'
import GxData from '/docs/components/_data.jsx'

/**
Expand Down Expand Up @@ -54,31 +53,30 @@ export default class Prerequisites extends React.Component {
defaultPrerequisiteItems () {
const returnItems = []
if (this.props.requirePython === true) {
returnItems.push(<li>A supported version of Python (versions {GxData.min_python} to {GxData.max_python})</li>)
returnItems.push(<ul><li>For details on how to download and install Python on your platform, please see <a href='https://www.python.org/doc/'>Python's documentation</a> and <a href='https://www.python.org/downloads/'>download sites</a></li></ul>)
returnItems.push(<li>A supported version of ({GxData.min_python} to {GxData.max_python}) Python. To download and install Python, see <a href='https://www.python.org/downloads/'>Python downloads.</a></li>)
}
if (this.props.requireInstallation === true) {
returnItems.push(<li>Set up an <a href='/docs/guides/setup/installation/local'>installation of Great Expectations</a></li>)
returnItems.push(<li>Great Exepctations <a href='/docs/guides/setup/installation/local'>installed and configured</a></li>)
}
if (this.props.requireDataContext === true) {
returnItems.push(<li><a href='/docs/guides/setup/configuring_data_contexts/how_to_configure_a_new_data_context_with_the_cli'>Created your Data Context</a></li>)
returnItems.push(<li><a href='/docs/guides/setup/configuring_data_contexts/how_to_configure_a_new_data_context_with_the_cli'>A Data Context</a></li>)
}
if (this.props.requireSourceData === 'filesystem') {
returnItems.push(<li>Access to data stored in a filesystem.</li>)
returnItems.push(<li>Access to data stored in a filesystem</li>)
} else if (this.props.requireSourceData === 'SQL') {
returnItems.push(<li>Access to data stored in a SQL database.</li>)
returnItems.push(<li>Access to data stored in a SQL database</li>)
}
if (this.props.requireDatasource === 'Pandas') {
returnItems.push(<li><a href='/docs/guides/connecting_to_your_data/datasource_configuration/how_to_configure_a_pandas_datasource'>Configured a Datasource to access your source data</a></li>)
returnItems.push(<li><a href='/docs/guides/connecting_to_your_data/datasource_configuration/how_to_configure_a_pandas_datasource'>A Datasource configured to access your source data</a></li>)
} else if (this.props.requireDatasource === 'Spark') {
returnItems.push(<li><a href='/docs/guides/connecting_to_your_data/datasource_configuration/how_to_configure_a_spark_datasource'>Configured a Datasource to access your source data</a></li>)
returnItems.push(<li><a href='/docs/guides/connecting_to_your_data/datasource_configuration/how_to_configure_a_spark_datasource'>A Datasource configured to access your source data</a></li>)
} else if (this.props.requireDatasource === 'SQL') {
returnItems.push(<li><a href='/docs/guides/connecting_to_your_data/datasource_configuration/how_to_configure_a_sql_datasource'>Configured a Datasource to access your source data</a></li>)
returnItems.push(<li><a href='/docs/guides/connecting_to_your_data/datasource_configuration/how_to_configure_a_sql_datasource'>A Datasource configured to access your source data</a></li>)
} else if (this.props.requireDatasource === true) {
returnItems.push(<li><a href='/docs/guides/connecting_to_your_data/connect_to_data_overview'>Configured a Datasource to access your source data</a></li>)
returnItems.push(<li><a href='/docs/guides/connecting_to_your_data/connect_to_data_overview'>A Datasource configured to access your source data</a></li>)
}
if (this.props.requireExpectationSuite === true) {
returnItems.push(<li><a href='/docs/guides/expectations/create_expectations_overview'>Configured and saved an Expectation Suite</a></li>)
returnItems.push(<li><a href='/docs/guides/expectations/create_expectations_overview'>An Expectation Suite configured and saved</a></li>)
}

return returnItems
Expand All @@ -87,12 +85,10 @@ export default class Prerequisites extends React.Component {
render () {
return (
<div>
<Admonition type='caution' title='This guide assumes you have:'>
<ul>
{this.defaultPrerequisiteItems()}
{this.extractMarkdownListItems().map((prereq, i) => (<li key={i}>{prereq}</li>))}
</ul>
</Admonition>
</div>
)
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -46,8 +46,7 @@ import VerifyDataContextInitializedFromCli from '/docs/components/setup/data_con
<Prerequisites requirePython = {true} requireInstallation = {false} requireDataContext = {false} requireSourceData = {null} requireDatasource = {false} requireExpectationSuite = {false}>

- The ability to install Python modules with pip
-
- A passion for data quality


</Prerequisites>

Expand Down
Original file line number Diff line number Diff line change
@@ -1 +1 @@
<span><a href='https://docs.microsoft.com/en-us/azure/storage'>Configured an Azure Storage account</a>.</span>
<span>An<a href='https://docs.microsoft.com/en-us/azure/storage'> Azure Storage account</a>.</span>
Original file line number Diff line number Diff line change
@@ -1,3 +1 @@
<span><a href='https://docs.microsoft.com/en-us/azure/storage'>Configured an Azure Storage account</a>. <ul><li>You will need
the <a href='https://docs.microsoft.com/en-us/azure/storage/common/storage-account-keys-manage?tabs=azure-portal'>
connection string</a> for this guide.</li></ul></span>
<span>An <a href='https://docs.microsoft.com/en-us/azure/storage'>Azure Storage account</a>. A <a href='https://docs.microsoft.com/en-us/azure/storage/common/storage-account-keys-manage?tabs=azure-portal'> connection string</a> is required to complete the setup.</span>
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@
<span>Created an Azure Blob container. <ul><li>If you also wish
to <a href='/docs/guides/setup/configuring_data_docs/how_to_host_and_share_data_docs_on_azure_blob_storage'>host and share Data Docs on Azure Blob Storage</a> then you may set up this first and then use the `$web` existing container to store your Expectations.</li></ul></span>
<span>An Azure Blob container. <ul><li>If you need
to <a href='/docs/guides/setup/configuring_data_docs/how_to_host_and_share_data_docs_on_azure_blob_storage'>host and share Data Docs on Azure Blob Storage,</a> you can set this up first, and then use the existing `$web` container to store your Expectations.</li></ul></span>
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@
<span>Permissions necessary to create and configure
<span>Permissions to create and configure
an <a href='https://docs.microsoft.com/en-us/azure/storage'>Azure Storage account</a></span>
Original file line number Diff line number Diff line change
@@ -1,2 +1 @@
<span>Configured your AWS credentials. <ul><li>For guidance in doing this, please see Amazon's documentation on configuring the
<a href='https://docs.aws.amazon.com/cli/latest/userguide/cli-chap-configure.html'>AWS CLI</a>.</li></ul></span>
<span>AWS credentials. <ul><li>See <a href='https://docs.aws.amazon.com/cli/latest/userguide/cli-chap-configure.html'>Configuring the AWS CLI</a>.</li></ul></span>
Original file line number Diff line number Diff line change
@@ -1 +1 @@
<span>Installed the AWS CLI. <ul><li>For guidance on how install this, please see <a href='https://docs.aws.amazon.com/cli/latest/userguide/getting-started-install.html'>Amazon's documentation on how to install the AWS CLI</a></li></ul></span>
<span>The AWS CLI. <ul><li>See <a href='https://docs.aws.amazon.com/cli/latest/userguide/getting-started-install.html'>Installing or updating the latest version of the AWS CLI</a></li></ul></span>
Original file line number Diff line number Diff line change
@@ -1 +1 @@
<span>Configured a <a href='https://cloud.google.com/iam/docs/service-accounts'>Google Cloud Platform (GCP) service account</a> with credentials that can access GCP resources, which include Storage Objects.</span>
<span>A <a href='https://cloud.google.com/iam/docs/service-accounts'>Google Cloud Platform (GCP) service account</a> with permissions to access GCP resources including Storage Objects.</span>
Original file line number Diff line number Diff line change
@@ -1 +1 @@
<span><a href='/docs/guides/setup/optional_dependencies/cloud/how_to_set_up_gx_to_work_with_data_in_abs'>Installed GX with dependencies for Azure Blob Storage</a></span>
<span><a href='/docs/guides/setup/optional_dependencies/cloud/how_to_set_up_gx_to_work_with_data_in_abs'>A working installation of Great Expectations with dependencies for Azure Blob Storage</a></span>
Original file line number Diff line number Diff line change
@@ -1 +1 @@
<span><a href='/docs/guides/setup/optional_dependencies/cloud/how_to_set_up_gx_to_work_with_data_on_aws_s3.md'>Installed GX with dependencies for AWS S3</a></span>
<span><a href='/docs/guides/setup/optional_dependencies/cloud/how_to_set_up_gx_to_work_with_data_on_aws_s3.md'>A working installation of Great Expectations with dependencies for AWS S3</a></span>
Original file line number Diff line number Diff line change
@@ -1 +1 @@
<span><a href='/docs/guides/setup/optional_dependencies/cloud/how_to_set_up_gx_to_work_with_data_on_gcs.md'>Installed GX with dependencies for GCS</a></span>
<span><a href='/docs/guides/setup/optional_dependencies/cloud/how_to_set_up_gx_to_work_with_data_on_gcs.md'>A working installation of Great Expectations with dependencies for Google Cloud Platform (GCP)</a></span>
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
Please reference the appropriate one of these guides:
See one of the following guides:
- [How to install GX locally](/docs/guides/setup/installation/local)
- [How to set up GX to work with data on AWS S3](/docs/guides/setup/optional_dependencies/cloud/how_to_set_up_gx_to_work_with_data_on_aws_s3)
- [How to set up GX to work with data in Azure Blob Storage](/docs/guides/setup/optional_dependencies/cloud/how_to_set_up_gx_to_work_with_data_in_abs)
Expand Down
Original file line number Diff line number Diff line change
@@ -1 +1 @@
<span><a href='/docs/tutorials/quickstart'>Completed the Quickstart guide</a></span>
<span><a href='/docs/tutorials/quickstart'>Completion of the Quickstart</a></span>
Original file line number Diff line number Diff line change
Expand Up @@ -13,9 +13,11 @@ import TechnicalTag from '@site/docs/term_tags/_tag.mdx';
This guide will help you connect to your data stored on Microsoft Azure Blob Storage (ABS) using Pandas.
This will allow you to <TechnicalTag tag="validation" text="Validate" /> and explore your data.

## Prerequisites

<Prerequisites>

- Have access to data on an ABS container
- Access to data on an ABS container

</Prerequisites>

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,10 +14,12 @@ import TechnicalTag from '@site/docs/term_tags/_tag.mdx';
This guide will help you connect to your data stored on Microsoft Azure Blob Storage (ABS) using Spark.
This will allow you to <TechnicalTag tag="validation" text="Validate" /> and explore your data.

## Prerequisites

<Prerequisites>

- Have access to data on an ABS container
- Have access to a working Spark installation
- Access to data on an ABS container
- Access to a working Spark installation

</Prerequisites>

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,9 +13,11 @@ import TechnicalTag from '@site/docs/term_tags/_tag.mdx';
This guide will help you connect to your data stored on GCS using Pandas.
This will allow you to <TechnicalTag tag="validation" text="Validate" /> and explore your data.

## Prerequisites

<Prerequisites>

- Have access to data on a GCS bucket
- Access to data on a GCS bucket

</Prerequisites>

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,10 +14,12 @@ import TechnicalTag from '@site/docs/term_tags/_tag.mdx';
This guide will help you connect to your data stored on Google Cloud Storage (GCS) using Spark.
This will allow you to <TechnicalTag tag="validation" text="Validate" /> and explore your data.

## Prerequisites

<Prerequisites>

- Have access to data on a GCS bucket
- Have access to a working Spark installation
- Access to data on a GCS bucket
- Access to a working Spark installation

</Prerequisites>

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,10 @@ import TechnicalTag from '@site/docs/term_tags/_tag.mdx';
This guide will help you connect to your data stored on AWS S3 using Pandas.
This will allow you to <TechnicalTag tag="validation" text="Validate" /> and explore your data.

## Prerequisites

<Prerequisites>

- Have access to data on an AWS S3 bucket
- Access to data on an AWS S3 bucket

</Prerequisites>
Original file line number Diff line number Diff line change
Expand Up @@ -7,4 +7,4 @@ Import these necessary packages and modules.

<SparkDataContextNote />

Please proceed only after you have instantiated your `DataContext`.
Proceed after you have instantiated your `DataContext`.
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,8 @@ import TechnicalTag from '@site/docs/term_tags/_tag.mdx';
This guide will help you connect to your data stored on AWS S3 using Spark.
This will allow you to <TechnicalTag tag="validation" text="Validate" /> and explore your data.

## Prerequisites

<Prerequisites>

- Access to data on an AWS S3 bucket
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -32,27 +32,20 @@ export default class Prerequisites extends React.Component {

defaultPrerequisiteItems () {
return [
<li key={0.1}><a href='/docs/tutorials/quickstart'>Completed the Quickstart guide</a></li>,
<li key={0.2}>A working installation of Great Expectations</li>
<li key={0.1}><a href='/docs/tutorials/quickstart'>Completion of the Quickstart guide.</a></li>,
<li key={0.2}>A working installation of Great Expectations.</li>
]
}

render () {
return (
<div className='admonition admonition-note alert alert--secondary'>
<div className='admonition-heading'>
<h5>
<span className='admonition-icon'><svg xmlns='http://www.w3.org/2000/svg' width='14' height='16' viewBox='0 0 14 16'><path fillRule='evenodd' d='M6.3 5.69a.942.942 0 0 1-.28-.7c0-.28.09-.52.28-.7.19-.18.42-.28.7-.28.28 0 .52.09.7.28.18.19.28.42.28.7 0 .28-.09.52-.28.7a1 1 0 0 1-.7.3c-.28 0-.52-.11-.7-.3zM8 7.99c-.02-.25-.11-.48-.31-.69-.2-.19-.42-.3-.69-.31H6c-.27.02-.48.13-.69.31-.2.2-.3.44-.31.69h1v3c.02.27.11.5.31.69.2.2.42.31.69.31h1c.27 0 .48-.11.69-.31.2-.19.3-.42.31-.69H8V7.98v.01zM7 2.3c-3.14 0-5.7 2.54-5.7 5.68 0 3.14 2.56 5.7 5.7 5.7s5.7-2.55 5.7-5.7c0-3.15-2.56-5.69-5.7-5.69v.01zM7 .98c3.86 0 7 3.14 7 7s-3.14 7-7 7-7-3.12-7-7 3.14-7 7-7z' /></svg></span>
Prerequisites: This how-to guide assumes you have:
</h5>
</div>
<div className='admonition-content'>
<div>
<ul>
{this.defaultPrerequisiteItems()}
{this.extractMarkdownListItems().map((prereq, i) => (<li key={i}>{prereq}</li>))}
</ul>
</div>
</div>
)
}
}

Original file line number Diff line number Diff line change
Expand Up @@ -14,13 +14,13 @@ import TechnicalTag from '@site/docs/term_tags/_tag.mdx';

<!-- Only keep one of the 'To best understand this document' lines. For processes like the Universal Map steps, use the first one. For processes like the Architecture Reviews, use the second one. -->

:::note Prerequisites
- Completing the [Quickstart guide](tutorials/quickstart/quickstart.md) is recommended.
:::

Connecting to your data in Great Expectations is designed to be a painless process. Once you have defined your Datasources and Data Assets, you will have a consistent API for accessing and validating data on all kinds of source data systems such as SQL-type data sources, local and remote file stores, and in-memory data frames.
After you have defined your Datasources and Data Assets, you will have a consistent API for accessing and validating data on all kinds of source data systems such as SQL-type data sources, local and remote file stores, and in-memory data frames.

## The connect to data process
## Prerequisites

- Completion of the [Quickstart guide](tutorials/quickstart/quickstart.md)

## The connect to data workflow

<!-- Brief outline of what the process entails. -->

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,8 @@ import ConnectionStringAthena from './components/_connection_string_athena.md'

This guide will help you add an Athena instance (or a database) as a <TechnicalTag tag="datasource" text="Datasource" />. This will allow you to <TechnicalTag tag="validation" text="Validate" /> tables and queries within this instance. When you use an Athena Datasource, the validation is done in Athena itself. Your data is not downloaded.

## Prerequisites

<Prerequisites>

- [Set up a working deployment of Great Expectations](/docs/guides/setup/setup_overview)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,10 +13,12 @@ import TechnicalTag from '@site/docs/term_tags/_tag.mdx';
This guide will help you connect to data in a BigQuery database.
This will allow you to <TechnicalTag tag="validation" text="Validate" /> and explore your data.

## Prerequisites

<Prerequisites>

- Have access to data in a BigQuery database
- Followed the [Google Cloud Library guide](https://googleapis.dev/python/google-api-core/latest/auth.html) for authentication
- Access to data in a BigQuery database
- Completion of the [Google Cloud Library guide](https://googleapis.dev/python/google-api-core/latest/auth.html) for authentication

</Prerequisites>

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,9 +14,11 @@ import SqlAlchemy2 from '/docs/components/warnings/_sql_alchemy2.md'
This guide will help you connect to data in a MSSQL database.
This will allow you to <TechnicalTag tag="validation" text="Validate" /> and explore your data.

## Prerequisites

<Prerequisites>

- Have access to data in a MSSQL database
- Access to data in a MSSQL database

</Prerequisites>

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,9 +15,11 @@ import SqlAlchemy2 from '/docs/components/warnings/_sql_alchemy2.md'
This guide will help you connect to data in a MySQL database.
This will allow you to <TechnicalTag tag="validation" text="Validate" /> and explore your data.

## Prerequisites

<Prerequisites>

- Have access to data in a MySQL database
- Access to data in a MySQL database

</Prerequisites>

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,9 +14,11 @@ import SqlAlchemy2 from '/docs/components/warnings/_sql_alchemy2.md'
This guide will help you connect to data in a PostgreSQL database.
This will allow you to <TechnicalTag tag="validation" text="Validate" /> and explore your data.

## Prerequisites

<Prerequisites>

- Have access to data in a Postgres database
- Access to data in a Postgres database

</Prerequisites>

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,9 +17,11 @@ import TechnicalTag from '@site/docs/term_tags/_tag.mdx';
This guide will help you connect to data in a Redshift database.
This will allow you to <TechnicalTag tag="validation" text="Validate" /> and explore your data.

## Prerequisites

<Prerequisites>

- Have access to data in a Redshift database
- Access to data in a Redshift database

</Prerequisites>

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,8 @@ import SqlAlchemy2 from '/docs/components/warnings/_sql_alchemy2.md'
This guide will help you connect to data in a Snowflake database.
This will allow you to <TechnicalTag tag="validation" text="Validate" /> and explore your data.

## Prerequisites

<Prerequisites>

- Have access to data in a Snowflake database
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,8 @@ import SqlAlchemy2 from '/docs/components/warnings/_sql_alchemy2.md'
This guide will help you connect to data in a SQLite database.
This will allow you to <TechnicalTag tag="validation" text="Validate" /> and explore your data.

## Prerequisites

<Prerequisites>

- Have access to data in a SQLite database
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,12 +9,13 @@ import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
import TechnicalTag from '@site/docs/term_tags/_tag.mdx';

This guide will help you connect to your data stored on a filesystem using pandas.
This will allow you to <TechnicalTag tag="validation" text="Validate" /> and explore your data.
This guide will help you connect to your data stored on a filesystem using pandas. This will allow you to <TechnicalTag tag="validation" text="Validate" /> and explore your data.

## Prerequisites

<Prerequisites>

- Have access to data on a filesystem
- Access to data on a filesystem

</Prerequisites>

Expand Down
Loading