sidebarsAstro.js

/**
 * Creating a sidebar enables you to:
 - create an ordered group of docs
 - render a sidebar for each doc of that group
 - provide next/previous navigation
 The sidebars can be generated from the filesystem, or explicitly defined here.
 Create as many sidebars as you want.
 */

module.exports = {
  cloud: [
    {
      type: 'category',
      label: 'Overview',
      link: { type: 'doc', id: 'overview' },
      items: [
        'astro-architecture',
        'features',
      ],
    },
    {
      type: "category",
      label: "Get started",
      items: [
        "trial",
        {
          type: "category",
          label: "Run your first DAG",
          link: { type: 'doc', id: 'run-first-dag' },
          items: ["first-dag-github-actions", "first-dag-cli"],

        },
        "log-in-to-astro",
        {
          type: "category",
          label: "Migrate to Astro",
          items: ["migrate-mwaa", "migrate-gcc"],
        },
        "install-azure",
      ],
    },
    {
      type: "category",
      label: "Develop DAGs",
      items: [
        'dags-overview',
        {
          type: 'link',
          label: 'Astro projects',
          href: 'https://www.astronomer.io/docs/astro/cli/develop-project',
        },
        {
          type: "category",
          label: "Connections and variables",
          items: [
            "manage-connections-variables",
            "create-and-link-connections",
            "import-export-connections-variables",
          ],
        },
        "upgrade-runtime",
        "kubernetespodoperator",
        "dag-metrics",
        "view-logs",
        "manage-dags",
        "airflow-api",
        {
          type: "category",
          label: "Cloud IDE",
          items: [
            "cloud-ide/overview",
            "cloud-ide/quickstart",
            "cloud-ide/run-python",
            "cloud-ide/run-sql",
            "cloud-ide/use-airflow-operators",
            "cloud-ide/document-pipeline",
            "cloud-ide/pass-data-between-cells",
            "cloud-ide/run-cells",
            "cloud-ide/configure-project-environment",
            "cloud-ide/deploy-project",
            "cloud-ide/security",
            "cloud-ide/custom-cell-reference"
          ],
        },
      ],
    },
    {
      type: "category",
      label: "Deploy code",
      items: [
        "deploy-code",
        "deploy-project-image",
        "deploy-dags",
        "deploy-github-integration",
        "deploy-history",
      ],
    },
    {
      type: "category",
      label: "Manage Deployments",
      items: [
        "create-deployment",
        {
          type: "category",
          label: "Deployment settings",
          items: ["deployment-settings", "deployment-details", "deployment-resources"],
        },
        {
          type: "category",
          label: "Executors",
          items: ["executors-overview", "celery-executor", "kubernetes-executor"],
        },
        "configure-worker-queues",
        {
          type: "category",
          label: "Environment variables",
          link: {
            type: 'doc',
            id: 'environment-variables'
          },
          items: ["environment-variables", "manage-env-vars"],
        },
        {
          type: "category",
          label: "Secrets backend",
          link: { type: 'doc', id: 'secrets-backend' },
          items: ["secrets-backend",
            "secrets-backend/aws-secretsmanager",
            "secrets-backend/aws-paramstore",
            "secrets-backend/azure-key-vault",
            "secrets-backend/hashicorp-vault",
            "secrets-backend/gcp-secretsmanager",
          ],
        },
      ],
    },
    {
      type: "category",
      label: "Automation & CI/CD",
      items: [
        "automation-overview",
        "automation-authentication",
        {
          type: "category",
          label: "CI/CD",
          items: [
            "set-up-ci-cd",
            {
              type: "category",
              label: "CI/CD templates",
              items: [
                "ci-cd-templates/template-overview",
                {
                  type: "category",
                  label: "Github Actions",
                  items: [
                    "ci-cd-templates/github-actions-template",
                    "ci-cd-templates/github-actions-deployment-preview",
                    "ci-cd-templates/github-actions-private-network",
                  ],
                },
                "ci-cd-templates/jenkins",
                "ci-cd-templates/gitlab",
                "ci-cd-templates/aws-s3",
                "ci-cd-templates/aws-codebuild",
                "ci-cd-templates/azure-devops",
                "ci-cd-templates/gcs",
                "ci-cd-templates/bitbucket",
                "ci-cd-templates/circleci",
                "ci-cd-templates/drone",
              ],
            },
          ],
        },
        {
          type: "category",
          label: "Manage Deployments as code",
          items: [
            "manage-deployments-as-code",
            "deployment-file-reference"],
        },
      ],
    },
    {
      type: "category",
      label: "Platform observability",
      items: [
        {
          type: "category",
          label: "View metrics",
          items: [
            "deployment-metrics",
            {
              type: "category",
              label: "Organization dashboards",
              items: ["organization-dashboard",
                "org-dash-exports",
              ],
            },
          ],
        },
        {
          type: "category",
          label: "Data lineage",
          items: ["data-lineage-concepts", "set-up-data-lineage", "data-lineage"],
        },
        "deployment-health-incidents",
        "alerts",
        "airflow-email-notifications",
        "audit-logs",
        "export-metrics",
        {
          type: "category",
          label: "Integrate with data tools",
          items: ["export-datadog", "export-cloudwatch"],
        },
      ],
    },
    {
      type: "category",
      label: "Administration",
      items: [
        {
          type: "category",
          label: "User access",
          items: [
            "manage-organization-users",
            "manage-workspace-users",
            "manage-teams",
            "configure-idp",
            "ip-access-list",
            "set-up-scim-provisioning",
            "manage-domains",
            "user-permissions",
          ],
        },
        {
          type: "category",
          label: "Deployments",
          items: [
            "deployment-api-tokens",
            "customize-deployment-roles",
            "authorize-deployments-to-your-cloud",
            "transfer-a-deployment",
          ],
        },
        {
          type: "category",
          label: "Workspaces",
          items: ["manage-workspaces", "workspace-api-tokens"],
        },
        {
          type: "category",
          label: "Clusters",
          items: [
            "create-dedicated-cluster",
            "authorize-workspaces-to-a-cluster",
            "resource-reference-hosted",
          ],
        },
        {
          type: "category",
          label: "Networking",
          items: [
            "networking-overview",
            "connect-aws",
            "connect-azure",
            "connect-gcp"
          ],
        },
        {
          type: "category",
          label: "Organization",
          items: [
            "organization-settings",
            "organization-api-tokens",
          ],
        },
        {
          type: "category",
          label: "Astro Hybrid",
          items: [
            "hybrid-overview",
            {
              type: "category",
              label: "Install Astro Hybrid",
              link: {
                type: 'generated-index',
                title: 'Install Astro Hybrid',
                description: 'Install Astro Hybrid on your cloud.'
              },
              items: ["install-aws-hybrid", "install-azure-hybrid", "install-gcp-hybrid"],
            },
            "manage-hybrid-clusters",
            {
              type: "category",
              label: "Hybrid cluster settings reference",
              link: {
                type: "generated-index",
                title: "Astro Hybrid cluster settings reference",
                description:
                  "Manage your existing AWS, Azure, or GCP cluster resource settings on Astro. Unless otherwise specified, new clusters on Astro are created with a set of default resources that should be suitable for standard use cases.",
              },
              items: [
                "resource-reference-aws-hybrid",
                "resource-reference-azure-hybrid",
                "resource-reference-gcp-hybrid",
              ],
            },
          ],
        },
        "manage-billing",
      ],
    },
    {
      type: "category",
      label: "Release notes",
      items: [
        "release-notes",
        "runtime-release-notes",
        {
          type: 'link',
          label: 'Astro CLI',
          href: 'https://www.astronomer.io/docs/astro/cli/release-notes',
        },
        "release-notes-subscribe",
      ],
    },
    {
      type: 'category',
      label: 'Best practices',
      items: [
        'best-practices/upgrading-astro-runtime',
        'best-practices/airflow-vs-astro-alerts',
        'best-practices/connections-branch-deploys',
        'best-practices/cross-deployment-dependencies',
        'best-practices/dag-writing-on-astro',
        'best-practices/deploy-with-api',
        'best-practices/manage-dev-deployments',
      ],
    },
    {
      type: "category",
      label: "Reference",
      items: [
        "astro-support",
        "astro-office-hours",
        {
          type: "category",
          label: "Astro Runtime",
          items: [
            "runtime-image-architecture",
            "runtime-version-lifecycle-policy",
            "runtime-provider-reference"
          ],
        },
        'platform-variables',
        'deployment-role-reference',
        "allowlist-domains",
        "feature-previews",
        "hosted-hybrid-reference",
        {
          type: "category",
          label: "Security",
          link: { type: "doc", id: "security" },
          items: [
            "shared-responsibility-model",
            "resilience",
            "disaster-recovery",
            "data-protection",
            "gdpr-compliance",
            "hipaa-compliance",
            "secrets-management",
          ],
        },
        "astro-glossary"
      ],
    },
    {
      type: 'link',
      label: 'Astro API',
      href: 'https://www.astronomer.io/docs/api',
    },
  ],
  cli: [
    {
      type: "doc",
      label: "CLI overview",
      id: "cli/overview",
    },
    {
      type: "doc",
      label: "Install the CLI",
      id: "cli/install-cli",
    },
    {
      type: "doc",
      label: "Get started with the CLI",
      id: "cli/get-started-cli",
    },
    {
      type: "doc",
      label: "Develop your project",
      id: "cli/develop-project",
    },
    {
      type: "category",
      label: "Run Airflow locally",
      items: [
        "cli/local-airflow-overview",
        "cli/run-airflow-locally",
        "cli/local-connections",
        "cli/troubleshoot-locally"
      ]
    },
    {
      type: "doc",
      label: "Test your project",
      id: "cli/test-your-astro-project-locally",
    },
    {
      type: "doc",
      label: "Release notes",
      id: "cli/release-notes",
    },
    {
      type: "doc",
      label: "Release policy",
      id: "cli/release-lifecycle-policy",
    },
    {
      type: "category",
      label: "Advanced",
      items: [
        "cli/configure-cli",
        "cli/use-podman",
        "cli/customize-dockerfile",
        "cli/private-python-packages",
        "cli/authenticate-to-clouds",
        "cli/airflowignore",
      ],
    },
    {
      type: 'category',
      label: 'Command reference',
      link: { type: 'doc', id: 'cli/reference' },
      items: [
        'cli/astro-completion',
        {
          type: "category",
          label: "astro config",
          link: {
            type: 'generated-index',
            title: "astro config command reference",
            description: 'Use `astro config` commands to configure how the Astro CLI behaves in your local environment.'
          },
          items: [
            'cli/astro-config-get',
            'cli/astro-config-set',
          ],
        },
        {
          type: "category",
          label: "astro context",
          link: {
            type: 'generated-index',
            title: "astro context command reference",
            description: 'Use `astro context` commands to switch between Astronomer product types.'
          },
          items: [
            'cli/astro-context-delete',
            'cli/astro-context-list',
            'cli/astro-context-switch',
          ],
        },
        'cli/astro-deploy',
        {
          type: "category",
          label: "astro deployment",
          link: {
            type: 'generated-index',
            title: "astro workspace command reference",
            description: 'Use `astro deployment` commands to manage all details about Deployments, including Deployment resources, Airflow objects, and Astro Runtime versioning.'
          },
          items: [
            'cli/astro-deployment-airflow-upgrade',
            {
              type: "category",
              label: "astro deployment airflow-variable",
              items: [
                'cli/astro-deployment-airflow-variable-copy',
                'cli/astro-deployment-airflow-variable-create',
                'cli/astro-deployment-airflow-variable-list',
                'cli/astro-deployment-airflow-variable-update',
              ],
            },
            {
              type: "category",
              label: "astro deployment connection",
              items: [
                'cli/astro-deployment-connection-copy',
                'cli/astro-deployment-connection-create',
                'cli/astro-deployment-connection-list',
                'cli/astro-deployment-connection-update',
              ],
            },
            'cli/astro-deployment-create',
            'cli/astro-deployment-delete',
            'cli/astro-deployment-hibernate',
            'cli/astro-deployment-inspect',
            'cli/astro-deployment-list',
            'cli/astro-deployment-logs',
            {
              type: "category",
              label: "astro deployment pool",
              items: [
                'cli/astro-deployment-pool-copy',
                'cli/astro-deployment-pool-create',
                'cli/astro-deployment-pool-list',
                'cli/astro-deployment-pool-update',
              ],
            },
            'cli/astro-deployment-runtime-upgrade',
            'cli/astro-deployment-service-account',
            'cli/astro-deployment-team',
            {
              type: "category",
              label: "astro deployment token",
              items: [
                'cli/astro-deployment-token-create',
                'cli/astro-deployment-token-delete',
                'cli/astro-deployment-token-list',
                "cli/astro-deployment-token-organization-token",
                "cli/astro-deployment-token-workspace-token",
                'cli/astro-deployment-token-rotate',
                'cli/astro-deployment-token-update',
              ],
            },
            'cli/astro-deployment-update',
            'cli/astro-deployment-user',
            {
              type: "category",
              label: "astro deployment variable",
              items: [
                'cli/astro-deployment-variable-create',
                'cli/astro-deployment-variable-list',
                'cli/astro-deployment-variable-update',
              ],
            },
            'cli/astro-deployment-wake-up',
            {
              type: "category",
              label: "astro deployment worker-queue",
              items: [
                'cli/astro-deployment-worker-queue-create',
                'cli/astro-deployment-worker-queue-delete',
                'cli/astro-deployment-worker-queue-update',
              ],
            },
          ],
        },
        {
          type: "category",
          label: "astro dev",
          link: {
            type: 'generated-index',
            title: "astro dev command reference",
            description: 'Use `astro dev` commands to manage your Astro project and interact with your local Airflow environment.'
          },
          items: [
            'cli/astro-dev-bash',
            'cli/astro-dev-init',
            'cli/astro-dev-kill',
            'cli/astro-dev-logs',
            'cli/astro-dev-object-export',
            'cli/astro-dev-object-import',
            'cli/astro-dev-parse',
            'cli/astro-dev-ps',
            'cli/astro-dev-pytest',
            'cli/astro-dev-restart',
            'cli/astro-dev-run',
            'cli/astro-dev-start',
            'cli/astro-dev-stop',
            'cli/astro-dev-upgrade-test',
          ],
        },
        'cli/astro-login',
        'cli/astro-logout',
        {
          type: "category",
          label: "astro organization",
          link: {
            type: 'generated-index',
            title: "astro organization command reference",
            description: 'Use `astro organization` commands to manage users and their Organization-level permissions.'
          },
          items: [
            "cli/astro-organization-list",
            "cli/astro-organization-switch",
            "cli/astro-organization-role-list",
            "cli/astro-organization-team-create",
            "cli/astro-organization-team-delete",
            "cli/astro-organization-team-list",
            "cli/astro-organization-team-update",
            "cli/astro-organization-team-user",
            "cli/astro-organization-token-create",
            "cli/astro-organization-token-delete",
            "cli/astro-organization-token-list",
            "cli/astro-organization-token-roles",
            "cli/astro-organization-token-rotate",
            "cli/astro-organization-token-update",
            "cli/astro-organization-user-invite",
            "cli/astro-organization-user-list",
            "cli/astro-organization-user-update",

          ],
        },
        {
          type: "category",
          label: "astro registry",
          link: {
            type: 'generated-index',
            title: "astro registry command reference",
            description: 'Use `astro registry` commands to pull resources from the Astronomer Registry into your Astro project.'
          },
          items: [
            "cli/astro-registry-dag-add",
            "cli/astro-registry-provider-add"
          ],
        },
        'cli/astro-run',
        'cli/astro-team',
        'cli/astro-user-create',
        'cli/astro-version',
        {
          type: "category",
          label: "astro workspace",
          link: {
            type: 'generated-index',
            title: "astro workspace command reference",
            description: 'Use `astro workspace` commands to manage Workspaces and Workspace-level user permissions.'
          },
          items: [
            "cli/astro-workspace-create",
            "cli/astro-workspace-delete",
            "cli/astro-workspace-list",
            "cli/astro-workspace-service-account",
            "cli/astro-workspace-switch",
            "cli/astro-workspace-team-add",
            "cli/astro-workspace-team-list",
            "cli/astro-workspace-team-remove",
            "cli/astro-workspace-team-update",
            "cli/astro-workspace-token-add",
            "cli/astro-workspace-token-create",
            "cli/astro-workspace-token-list",
            "cli/astro-workspace-token-organization-token",
            "cli/astro-workspace-token-rotate",
            "cli/astro-workspace-token-update",
            "cli/astro-workspace-update",
            "cli/astro-workspace-user-add",
            "cli/astro-workspace-user-list",
            "cli/astro-workspace-user-remove",
            "cli/astro-workspace-user-update",
          ],
        },
      ],
    },
  ],
};