sidebars.js

module.exports = {
  docs: [
    {
      type: 'category',
      label: 'Introduction',
      collapsed: false,
      items: [
        { type: 'doc', id: 'intro' },
        { type: 'doc', id: 'why-use-ge' }
      ]
    },
    {
      type: 'category',
      label: 'Getting started with Great Expectations',
      items: [
        'tutorials/getting-started/intro',
        'tutorials/getting-started/initialize-a-data-context',
        'tutorials/getting-started/connect-to-data',
        'tutorials/getting-started/create-your-first-expectations',
        'tutorials/getting-started/set-up-data-docs',
        'tutorials/getting-started/validate-your-data',
        'tutorials/getting-started/customize-your-deployment'
      ]
    },
    {
      type: 'category',
      label: 'How to Guides',
      items: [
        {
          type: 'link',
          label: 'Interactive How-To Guide',
          href: '/demo'
        },
        {
          type: 'category',
          label: '⚙️ Setting up your Great Expectations',
          items: [
            {
              type: 'category',
              label: 'Installing',
              items: [
                'guides/setup/installing/local',
                'guides/setup/installing/databricks',
                'guides/setup/installing/spark-emr'
              ]
            },
            {
              type: 'category',
              label: 'Configuring Data Contexts',
              items: [
                'guides/setup/configuring-data-contexts/how-to-create-a-new-data-context-with-the-cli',
                'guides/setup/configuring-data-contexts/how-to-configure-datacontext-components-using-test_yaml_config',
                'guides/setup/configuring-data-contexts/how-to-use-a-yaml-file-or-environment-variables-to-populate-credentials',
                'guides/setup/configuring-data-contexts/how-to-populate-credentials-from-a-secrets-store',
                'guides/setup/configuring-data-contexts/how-to-instantiate-a-data-context-without-a-yml-file',
                'guides/setup/configuring-data-contexts/how-to-instantiate-a-data-context-on-an-emr-spark-cluster',
                'guides/setup/configuring-data-contexts/how-to-instantiate-a-data-context-on-databricks-spark-cluster'

              ]
            },
            {
              type: 'category',
              label: 'Configuring metadata Stores',
              items: [
                'guides/setup/configuring-metadata-stores/how-to-configure-an-expectation-store-in-amazon-s3',
                'guides/setup/configuring-metadata-stores/how-to-configure-an-expectation-store-in-azure-blob-storage',
                'guides/setup/configuring-metadata-stores/how-to-configure-an-expectation-store-in-gcs',
                'guides/setup/configuring-metadata-stores/how-to-configure-an-expectation-store-on-a-filesystem',
                'guides/setup/configuring-metadata-stores/how-to-configure-an-expectation-store-to-postgresql',
                'guides/setup/configuring-metadata-stores/how-to-configure-a-validation-result-store-in-amazon-s3',
                'guides/setup/configuring-metadata-stores/how-to-configure-a-validation-result-store-in-azure-blob-storage',
                'guides/setup/configuring-metadata-stores/how-to-configure-a-validation-result-store-in-gcs',
                'guides/setup/configuring-metadata-stores/how-to-configure-a-validation-result-store-on-a-filesystem',
                'guides/setup/configuring-metadata-stores/how-to-configure-a-validation-result-store-to-postgresql',
                'guides/setup/configuring-metadata-stores/how-to-configure-a-metricsstore'
              ]
            },
            {
              type: 'category',
              label: 'Configuring Data Docs',
              items: [
                'guides/setup/configuring-data-docs/how-to-add-comments-to-expectations-and-display-them-in-data-docs',
                'guides/setup/configuring-data-docs/how-to-create-renderers-for-custom-expectations',
                'guides/setup/configuring-data-docs/how-to-host-and-share-data-docs-on-a-filesystem',
                'guides/setup/configuring-data-docs/how-to-host-and-share-data-docs-on-azure-blob-storage',
                'guides/setup/configuring-data-docs/how-to-host-and-share-data-docs-on-gcs',
                'guides/setup/configuring-data-docs/how-to-host-and-share-data-docs-on-amazon-s3'
              ]
            }
          ]
        },
        {
          type: 'category',
          label: '🔌 Connecting to your data',
          items: [

            {
              type: 'category',
              label: '🚀 Database',
              items: [
                'guides/connecting_to_your_data/database/athena',
                'guides/connecting_to_your_data/database/bigquery',
                'guides/connecting_to_your_data/database/mssql',
                'guides/connecting_to_your_data/database/mysql',
                'guides/connecting_to_your_data/database/postgres',
                'guides/connecting_to_your_data/database/redshift',
                'guides/connecting_to_your_data/database/snowflake',
                'guides/connecting_to_your_data/database/sqlite'
              ]
            },
            {
              type: 'category',
              label: '📁 Filesystem',
              items: [
                { type: 'doc', id: 'guides/connecting_to_your_data/filesystem/pandas' },
                { type: 'doc', id: 'guides/connecting_to_your_data/filesystem/spark' }
              ]
            },
            {
              type: 'category',
              label: '☁️ Cloud',
              items: [
                { type: 'doc', id: 'guides/connecting_to_your_data/cloud/s3/pandas' },
                { type: 'doc', id: 'guides/connecting_to_your_data/cloud/s3/spark' },
                { type: 'doc', id: 'guides/connecting_to_your_data/cloud/gcs/pandas' },
                { type: 'doc', id: 'guides/connecting_to_your_data/cloud/gcs/spark' },
                { type: 'doc', id: 'guides/connecting_to_your_data/cloud/azure/pandas' },
                { type: 'doc', id: 'guides/connecting_to_your_data/cloud/azure/spark' }
              ]
            },

            {
              type: 'category',
              label: '🍏 Core Skills',
              items: [
                {
                  type: 'category',
                  label: '✳️  How to get a Batch of data from a configured Datasource',
                  items: [{ type: 'doc', id: 'guides/expectations/how-to-create-a-new-expectation-suite-using-the-cli' }]
                },

                {
                  type: 'category',
                  label: '✳️  How to create a Batch of data from a single file or in-memory dataframe',
                  items: [{ type: 'doc', id: 'guides/expectations/how-to-create-a-new-expectation-suite-using-the-cli' }]
                },

                {
                  type: 'category',
                  label: '✳️  How to configure a DataConnector to introspect and partition tables in SQL',
                  items: [{ type: 'doc', id: 'guides/expectations/how-to-create-a-new-expectation-suite-using-the-cli' }]
                },
                {
                  type: 'category',
                  label: '✳️  How to configure a DataConnector to introspect and partition a file system or blob store',
                  items: [{ type: 'doc', id: 'guides/expectations/how-to-create-a-new-expectation-suite-using-the-cli' }]
                }

              ]

            },

            {
              type: 'category',
              label: '🏢 Contributing',
              items: [{ type: 'doc', id: 'guides/expectations/how-to-create-a-new-expectation-suite-using-the-cli' }]
            },
            {
              type: 'category',
              label: '🔬 Advanced',
              items: [
                'guides/connecting_to_your_data/advanced/database_credentials'
              ]
            }
          ]
        },
        {
          type: 'category',
          label: 'Creating and editing Expectations for your data',
          items: [
            { type: 'doc', id: 'guides/expectations/how-to-create-a-new-expectation-suite-using-the-cli' },
            { type: 'doc', id: 'guides/expectations/how-to-create-a-new-expectation-suite-without-a-sample-batch' },
            { type: 'doc', id: 'guides/expectations/how-to-create-a-new-expectation-suite-without-the-cli' },
            { type: 'doc', id: 'guides/expectations/how-to-edit-an-expectation-suite-with-the-cli' },
            { type: 'doc', id: 'guides/expectations/how-to-edit-an-expectation-suite-without-the-cli' },
            { type: 'doc', id: 'guides/expectations/how-to-edit-an-expectation-suite-without-a-sample-batch' },
            { type: 'doc', id: 'guides/expectations/how-to-create-an-expectation-suite-with-the-user-configurable-profiler' },
            { type: 'doc', id: 'guides/expectations/how-to-create-a-new-expectation-suite-from-a-jsonschema-file' },
            { type: 'doc', id: 'guides/expectations/how-to-create-custom-expectations' },
            { type: 'doc', id: 'guides/expectations/how-to-create-custom-expectations-for-pandas' },
            { type: 'doc', id: 'guides/expectations/how-to-create-custom-expectations-for-spark' },
            { type: 'doc', id: 'guides/expectations/how-to-create-custom-expectations-for-sqlalchemy' },
            { type: 'doc', id: 'guides/expectations/how-to-create-expectations-that-span-multiple-batches-using-evaluation-parameters' },
            { type: 'doc', id: 'guides/expectations/how-to-contribute-a-new-expectation-to-great-expectations' },
            { type: 'doc', id: 'guides/expectations/how-to-create-parameterized-expectations-super-fast' },
            { type: 'doc', id: 'guides/expectations/how-to-dynamically-load-evaluation-parameters-from-a-database' }
          ]
        },
        {
          type: 'category',
          label: '✅ Validating your data',
          items: [

            {
              type: 'category',
              label: 'Working with Validators (name TBD)',
              items: [
                { type: 'doc', id: 'guides/validation/validators/stub' }
              ]
            },
            {
              type: 'category',
              label: 'Creating and using Checkpoints for data validation',
              items: [
                { type: 'doc', id: 'guides/validation/checkpoints/how-to-create-a-new-checkpoint' },
                { type: 'doc', id: 'guides/validation/checkpoints/how-to-add-validations-data-or-suites-to-a-checkpoint' },
                { type: 'doc', id: 'guides/validation/checkpoints/how-to-configure-a-new-checkpoint-using-test_yaml_config' },
                { type: 'doc', id: 'guides/validation/checkpoints/how-to-run-a-checkpoint-in-terminal' },
                { type: 'doc', id: 'guides/validation/checkpoints/how-to-run-a-checkpoint-in-python' },
                { type: 'doc', id: 'guides/validation/checkpoints/how-to-run-a-checkpoint-in-airflow' },
                { type: 'doc', id: 'guides/validation/checkpoints/how-to-deploy-a-scheduled-checkpoint-with-cron' },
                { type: 'doc', id: 'guides/validation/checkpoints/how-to-store-validation-results-as-a-validation-action' },
                { type: 'doc', id: 'guides/validation/checkpoints/how-to-update-data-docs-as-a-validation-action' },
                { type: 'doc', id: 'guides/validation/checkpoints/how-to-trigger-email-as-a-validation-action' },
                { type: 'doc', id: 'guides/validation/checkpoints/how-to-trigger-slack-notifications-as-a-validation-action' },
                { type: 'doc', id: 'guides/validation/checkpoints/how-to-trigger-opsgenie-notifications-as-a-validation-action' },
                { type: 'doc', id: 'guides/validation/checkpoints/how-to-implement-a-custom-validation-operator' },
                { type: 'doc', id: 'guides/validation/checkpoints/how-to-implement-custom-notifications' },
                { type: 'doc', id: 'guides/validation/checkpoints/how-to-validate-data-without-a-checkpoint' }

              ]
            }
          ]
        },
        {
          type: 'category',
          label: 'Advanced Usage',
          items: [
            { type: 'doc', id: 'guides/advanced/how-to-configure-notebooks-generated-by-suite-edit' },
            { type: 'doc', id: 'guides/advanced/how-to-use-the-project-check-config-command' },
            { type: 'doc', id: 'guides/advanced/how-to-use-the-great-expectations-command-line-interface-(cli)' },
            { type: 'doc', id: 'guides/advanced/how-to-add-support-for-a-new-sqlalchemy-dialect' },
            { type: 'doc', id: 'guides/advanced/how-to-add-comments-to-a-page-on-docs.greatexpectations.io' },
            { type: 'doc', id: 'guides/advanced/how-to-use-the-great-expectation-docker-images' },
            { type: 'doc', id: 'guides/advanced/how-to-write-a-how-to-guide' },
            { type: 'doc', id: 'guides/advanced/template-how-to-{stub}' },
            { type: 'doc', id: 'guides/advanced/template-how-to-{do-something}' }
          ]
        }
      ]
    },
    {
      type: 'category',
      label: 'Reference',
      collapsed: true,
      items: [
        {
          type: 'category',
          label: 'Reference',
          items: [
            { type: 'doc', id: 'guides/setup/installing/local' }

          ]
        }
      ]
    },
    {
      type: 'category',
      label: 'Community Resources',
      collapsed: true,
      items: [
        {
          type: 'category',
          label: 'Community',
          items: [
            { type: 'doc', id: 'guides/setup/installing/local' }

          ]
        }
      ]
    },
    {
      type: 'category',
      label: 'Contributing',
      collapsed: true,
      items: [
        {
          type: 'category',
          label: 'Contributingt',
          items: [
            { type: 'doc', id: 'guides/setup/installing/local' }

          ]
        }
      ]
    },
    {
      type: 'category',
      label: 'Changelog',
      collapsed: true,
      items: [
        {
          type: 'category',
          label: 'Changelog',
          items: [
            { type: 'doc', id: 'guides/setup/installing/local' }

          ]
        }
      ]
    }
  ]
}