sidebars.js

// @ts-check

// This runs in Node.js - Don't use client-side code here (browser APIs, JSX...)

/**
 * 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.

 @type {import('@docusaurus/plugin-content-docs').SidebarsConfig}
 */
const sidebars = {
  // By default, Docusaurus generates a sidebar from the docs folder structure
  // tutorialSidebar: [{type: 'autogenerated', dirName: '.'}],

  // But you can create a sidebar manually

  tutorialSidebar: [
    // {
    //   type: 'doc',
    //   id: 'README',
    //   label: 'Introduction',
    // },


    // Getting Started
    {
      type: 'category',
      label: 'Getting Started',
      collapsed: true,
      link: {
        type: 'doc', // or 'generated-index'
        id: 'README',
      },
      items: [
        'setup/getting-started/initial-setup',
        // Install Devtron
        {
          type: 'category',
          label: 'Install Devtron',
          collapsed: true,
          link: {
            type: 'doc', // or 'generated-index'
            id: 'setup/install/README',
      },
          items: [
            'setup/install/devtron-oss',
            'setup/install/devtron-freemium',
            {
              type: 'link',
              label: 'Get Devtron Enterprise',
              href: 'https://devtron.ai/contact-sales',
            },
            // 'setup/install/install-devtron',
          ],
        },
      ],
    },

    // Application Management
    {
      type: 'category',
      label: 'Application Management',
      collapsed: true,
      link: {
        type: 'doc', // or 'generated-index'
        id: 'user-guide/app-management/README',
      },
      items: [
        'user-guide/app-management/application-overview',
        // Applications top
        {
          type: 'category',
          label: 'Devtron Applications',
          collapsed: true,
          link: {
            type: 'doc', // or 'generated-index'
            id: 'user-guide/applications',
          },
          items: [
            'user-guide/create-application',
            'user-guide/cloning-application',
            'user-guide/using-application-templates',
            // App Configuration nested
            {
              type: 'category',
              label: 'App Configurations',
              collapsed: true,
              link: {
                type: 'doc', // or 'generated-index'
                id: 'user-guide/creating-application/README',
              },
              items: [
                'user-guide/creating-application/git-material',
                'user-guide/creating-application/docker-build-configuration',
                // Base Configurations nested
                {
                  type: 'category',
                  label: 'Base Configurations',
                  collapsed: true,
                  link: {
                    type: 'doc', // or 'generated-index'
                    id: 'user-guide/creating-application/base-config/README',
                  },
                  items: [
                    'user-guide/creating-application/base-config/deployment-template',
                    // Types of Deployment Templates nested
                    {
                      type: 'category',
                      label: 'Types of Deployment Templates',
                      collapsed: true,
                      link: {
                        type: 'doc', // or 'generated-index'
                        id: 'user-guide/creating-application/base-config/deployment-template-types/README',
                      },
                      items: [
                        'user-guide/creating-application/base-config/deployment-template-types/deployment',
                        'user-guide/creating-application/base-config/deployment-template-types/rollout-deployment',
                        'user-guide/creating-application/base-config/deployment-template-types/job-and-cronjob',
                        'user-guide/creating-application/base-config/deployment-template-types/statefulset',
                      ],
                    },
                    'user-guide/creating-application/base-config/config-maps',
                    'user-guide/creating-application/base-config/secrets',
                    // External Secrets (ESO) nested
                    {
                      type: 'category',
                      label: 'Types of External Secrets',
                      collapsed: true,
                      link: {
                        type: 'doc', // or 'generated-index'
                        id: 'user-guide/creating-application/base-config/eso/README',
                      },
                      items: [
                        'user-guide/creating-application/base-config/eso/install-eso',
                        'user-guide/creating-application/base-config/eso/aws-eso',
                        'user-guide/creating-application/base-config/eso/gcp-eso',
                        'user-guide/creating-application/base-config/eso/hashicorp-eso',
                      ],
                    },
                  ],
                },
                'user-guide/creating-application/gitops-config',
                // Workflow Editor nested
                {
                  type: 'category',
                  label: 'Workflow Editor',
                  collapsed: true,
                  link: {
                    type: 'doc', // or 'generated-index'
                    id: 'user-guide/creating-application/workflow/README',
                  },
                  items: [
                    'user-guide/creating-application/workflow/ci-pipeline',
                    'user-guide/creating-application/workflow/cd-pipeline',
                    'user-guide/creating-application/workflow/pre-post-tasks',
                  ],
                },
                'user-guide/creating-application/environment-overrides',
                'user-guide/deleting-application',
              ],
            },

            // Build and Deploy nested
            {
              type: 'category',
              label: 'Build and Deploy',
              collapsed: true,
              link: {
                type: 'doc', // or 'generated-index'
                id: 'user-guide/deploying-application/README',
              },
              items: [
                'user-guide/deploying-application/triggering-ci',
                'user-guide/deploying-application/triggering-cd',
                'user-guide/deploying-application/rollback-deployment',
                'user-guide/deploying-application/image-labels-and-comments',
              ],
            },

            // App Details nested
            {
              type: 'category',
              label: 'App Details',
              collapsed: true,
              link: {
                type: 'doc', // or 'generated-index'
                id: 'user-guide/app-details/README',
              },
              items: [
                'user-guide/app-details/application-summary',
                'user-guide/creating-application/app-metrics',
                'user-guide/app-details/deployment-visibility',
                'user-guide/app-details/ephemeral-containers',
              ],
            },

            // App overview (explicit)
            'user-guide/creating-application/overview',
          ],
        },

        // Application Groups
        'user-guide/application-groups',
        {
          type: 'category',
          label: 'Bulk Edit',
          collapsed: true,
          link: {
            type: 'doc', // or 'generated-index'
            id: 'user-guide/bulk-update',
          },
          items: [
            'user-guide/bulk-update/bulk-edit',
            'user-guide/bulk-update/bulk-edit-ent',
          ]
        },
        'user-guide/global-configurations/application-template',
        'user-guide/global-configurations/projects',

        // App Configurations
        {
          type: 'category',
          label: 'Configurations',
          collapsed: true,
          link: {
            type: 'doc', // or 'generated-index'
            id: 'user-guide/app-configurations/README',
          },
          items: [
            'user-guide/global-configurations/gitops',
            'user-guide/global-configurations/git-accounts',
            'user-guide/global-configurations/external-links',
            'user-guide/global-configurations/chart-repo',
            'user-guide/global-configurations/deployment-charts',
            'user-guide/global-configurations/manage-notification',
            'user-guide/global-configurations/scoped-variables',
            'user-guide/global-configurations/build-infra',
          ]
        },
        // Policies
        {
          type: 'category',
          label: 'Policies',
          collapsed: true,
          link: {
            type: 'doc', // or 'generated-index'
            id: 'user-guide/policies/README',
          },
          items: [
            'user-guide/global-configurations/deployment-window',
            'user-guide/global-configurations/approval-policy',
            'user-guide/global-configurations/plugin-policy',
            'user-guide/global-configurations/pull-image-digest',
            'user-guide/global-configurations/tags-policy',
            'user-guide/global-configurations/filter-condition',
            'user-guide/global-configurations/lock-deployment-config',
            'user-guide/global-configurations/image-promotion-policy',
          ]
        },
      ],
    },

    // Infrastructure Management
    {
      type: 'category',
      label: 'Infrastructure Management',
      collapsed: true,
      link: {
        type: 'doc', // or 'generated-index'
        id: 'user-guide/infra-management/README',
      },
      items: [
        'user-guide/infra-management/infrastructure-overview',
        'user-guide/infra-management/other-applications',
        // Chart Store section
        {
          type: 'category',
          label: 'Chart Store',
          collapsed: true,
          link: {
            type: 'doc', // or 'generated-index'
            id: 'user-guide/deploy-chart/README',
          },
          items: [
            'user-guide/deploy-chart/deployment-of-charts',
            'user-guide/deploy-chart/chart-group',
          ],
        },
        {
          type: 'category',
          label: 'Resource Browser',
          collapsed: true,
          link: {
            type: 'doc', // or 'generated-index'
            id: 'user-guide/resource-browser/README',
          },
          items: [
            'user-guide/resource-browser/overview',
            'user-guide/resource-browser/manage-resources',
            'user-guide/resource-browser/compare-and-sync',
            'user-guide/resource-browser/nodes',
            'user-guide/resource-browser/pods',
            'user-guide/resource-browser/scoop-config',
            'user-guide/resource-browser/resource-recommender',
            'user-guide/resource-browser/cluster-terminal',
            'user-guide/resource-browser/monitoring-graphs',
            'user-guide/resource-browser/kubectl-local',
            'user-guide/operations/edit-gui-schema',
            'user-guide/operations/edit-lock-schema',
          ],
        },
        'user-guide/resource-watcher',
      ]
    },

    // Software Release Management
    {
      type: 'category',
      label: 'Software Release Management',
      collapsed: true,
      link: {
        type: 'doc', // or 'generated-index'
        id: 'user-guide/software-distribution-hub/README',
      },
      items: [
        'user-guide/software-distribution-hub/tenants',
        'user-guide/software-distribution-hub/release-hub',
      ],
    },

    // Cost Visibility
    {
      type: 'category',
      label: 'Cost Visibility',
      collapsed: true,
      link: {
        type: 'doc', // or 'generated-index'
        id: 'user-guide/finops/README',
      },
      items: [
        'user-guide/finops/overview-cost-visibility',
        'user-guide/finops/cost-breakdown',
        'user-guide/finops/configurations',
      ],
    },

    // Security
    {
      type: 'category',
      label: 'Security',
      collapsed: true,
      link: {
        type: 'doc', // or 'generated-index'
        id: 'user-guide/security-features',
      },
      items: [
        'user-guide/security-features/security-overview',
        'user-guide/security-features/security-scans',
        'user-guide/security-features/security-policies',
      ],
    },

    // Automation & Enablement
    {
      type: 'category',
      label: 'Automation & Enablement',
      collapsed: true,
      link: {
        type: 'doc', // or 'generated-index'
        id: 'user-guide/automation/README',
      },
      items: [
        // Jobs
        {
          type: 'category',
          label: 'Jobs',
          collapsed: true,
          link: {
            type: 'doc', // or 'generated-index'
            id: 'user-guide/jobs/README',
          },
          items: [
            'user-guide/jobs/what-is-job',
            'user-guide/jobs/create-job',
            {
              type: 'category',
              label: 'Configurations',
              collapsed: true,
              link: {
                type: 'doc', // or 'generated-index'
                id: 'user-guide/jobs/configurations/README',
              },
              items: [
                'user-guide/jobs/configurations/source-code-job',
                'user-guide/jobs/configurations/workflow-editor-job',
                {
                  type: 'category',
                  label: 'ConfigMaps & Secrets',
                  collapsed: true,
                  link: {
                    type: 'doc', // or 'generated-index'
                    id: 'user-guide/jobs/configurations/configmap-secret/README',
                  },
                  items: [
                    'user-guide/jobs/configurations/configmap-secret/configmap-job',
                    'user-guide/jobs/configurations/configmap-secret/secret-job',
                  ],
                },
                'user-guide/jobs/configurations/environment-override-job',
              ],
            },
            'user-guide/jobs/triggering-job',
            'user-guide/jobs/run-history-job',
            'user-guide/jobs/overview-job',
          ],
        },
        // 'user-guide/automation/alerting',
        // 'user-guide/automation/incident-response',
        // 'user-guide/automation/api-portal',
        // 'user-guide/automation/runbook-automation',
      ],
    },

    //Backup & Restore
    {
      type: 'category',
      label: 'Backup & Restore',
      collapsed: true,
      link: {
        type: 'doc',
        id: 'user-guide/storageops/README',
      },
      items: [
        'user-guide/storageops/overview',
        'user-guide/storageops/backup',
        'user-guide/storageops/restores',
        'user-guide/storageops/backup-locations',
      ],
    },

    // AI Recommendations
    {
      type: 'category',
      label: 'AI Recommendations',
      collapsed: true,
      link: {
        type: 'doc', // or 'generated-index'
        id: 'user-guide/ai-recommendations/README',
      },
      items: [
        'user-guide/ai-recommendations/notifications',
        'user-guide/ai-recommendations/runbook',
      ],
    },

    // Global Configurations (top-level)
    {
      type: 'category',
      label: 'Global Configurations',
      collapsed: true,
      link: {
        type: 'doc', // or 'generated-index'
        id: 'user-guide/global-configurations/README',
      },
      items: [
        {
          type: 'category',
          label: 'SSO Login Services',
          collapsed: true,
          link: {
            type: 'doc', // or 'generated-index'
            id: 'user-guide/global-configurations/sso-login',
          },
          items: [
            'user-guide/global-configurations/authorization/sso/google',
            'user-guide/global-configurations/authorization/sso/github',
            'user-guide/global-configurations/authorization/sso/gitlab',
            'user-guide/global-configurations/authorization/sso/microsoft',
            'user-guide/global-configurations/authorization/sso/ldap',
            'user-guide/global-configurations/authorization/sso/oidc',
            'user-guide/global-configurations/authorization/sso/keycloak',
            'user-guide/global-configurations/authorization/sso/okta',
            'user-guide/global-configurations/authorization/sso/openshift',
          ],
        },
        'user-guide/global-configurations/host-url',
        {
          type: 'category',
          label: 'Cluster and Environments',
          collapsed: true,
          link: {
            type: 'doc', // or 'generated-index'
            id: 'user-guide/global-configurations/cluster-and-environments',
          },
          items: [
            'user-guide/global-configurations/clusters/add-clusters',
            'user-guide/global-configurations/clusters/manage-environments',
            'user-guide/global-configurations/clusters/manage-categories',
          ],
        },
        'user-guide/global-configurations/container-registries',
        // Authorization nested
        {
          type: 'category',
          label: 'Authorization',
          collapsed: true,
          link: {
            type: 'doc', // or 'generated-index'
            id: 'user-guide/global-configurations/authorization/README',
          },
          items: [
            'user-guide/global-configurations/authorization/user-access',
            'user-guide/global-configurations/authorization/permission-groups',
            'user-guide/global-configurations/authorization/api-tokens',
          ],
        },
      ],
    },

    // Resources (top-level)
    {
      type: 'category',
      label: 'Resources',
      collapsed: true,
      link: {
        type: 'doc', // or 'generated-index'
        id: 'reference/resources',
      },
      items: [
        'reference/glossary',
        'FAQs/devtron-troubleshoot',
        {
          type: 'category',
          label: 'Upgrade Devtron',
          collapsed: true,
          link: {
            type: 'doc', // or 'generated-index'
            id: 'setup/upgrade/README',
          },
          items: [
            'setup/upgrade/upgrade-devtron-ui',
            'setup/upgrade/devtron-upgrade-1.5.0',
            'setup/upgrade/devtron-upgrade-0.6.x-0.7.x',
            'setup/upgrade/devtron-upgrade-0.5.x-0.6.x',
            'setup/upgrade/devtron-upgrade-0.4.x-0.5.x',
            'setup/upgrade/devtron-upgrade-0.4.x-0.4.x',
            'setup/upgrade/devtron-upgrade-0.3.x-0.4.x',
            'setup/upgrade/devtron-upgrade-0.3.x-0.3.x',
            'setup/upgrade/devtron-upgrade-0.2.x-0.3.x',
          ],
        },

        {
          type: 'category',
          label: 'Additional Installation Resources',
          collapsed: true,
          link: {
            type: 'doc', // or 'generated-index'
            id: 'reference/README',
          },
          items: [
            'setup/install/prod-infra',
            'setup/configurations/configurations-overview',
            'setup/install/installation-configuration',
            'setup/install/override-default-devtron-installation-configs',
            'setup/install/ingress-setup',
            'setup/install/install-devtron-in-airgapped-environment',
            // 'setup/install/freemium',
            'setup/install/install-devtron-Kubernetes-client',
            'setup/install/demo-tutorials',
            'setup/install/devtron-backup',
            'setup/install/faq-on-installation',
          ],
        },

        // Integrations
        {
          type: 'category',
          label: 'Integrations',
          collapsed: true,
          link: {
            type: 'doc', // or 'generated-index'
            id: 'user-guide/integrations/README',
          },
          items: [
            'user-guide/integrations/build-and-deploy-ci-cd',
            'user-guide/integrations/argocd',
            {
              type: 'category',
              label: 'Vulnerability Scanning',
              collapsed: true,
              link: {
                type: 'doc', // or 'generated-index'
                id: 'user-guide/integrations/vulnerability-scanning/README',
              },
              items: [
                'user-guide/integrations/vulnerability-scanning/clair',
                'user-guide/integrations/vulnerability-scanning/trivy',
              ],
            },
            'user-guide/integrations/notifications',
            'user-guide/integrations/grafana',
          ],
        },

        // Pipeline Plugins
        {
          type: 'category',
          label: 'Pipeline Plugins',
          collapsed: true,
          link: {
            type: 'doc', // or 'generated-index'
            id: 'user-guide/plugins/README',
          },
          items: [
            'user-guide/plugins/create-plugin',
            'user-guide/plugins/plugin-list',
            'user-guide/plugins/ansible-runner',
            'user-guide/plugins/bitbucket-runner-trigger',
            'user-guide/plugins/codacy',
            'user-guide/plugins/code-scan',
            'user-guide/plugins/copacetic',
            'user-guide/plugins/container-image-exporter',
            'user-guide/plugins/copy-container-image',
            'user-guide/plugins/cosign',
            'user-guide/plugins/crane-copy',
            'user-guide/plugins/dependency-track-maven-gradle',
            'user-guide/plugins/dependency-track-nodejs',
            'user-guide/plugins/dependency-track-python',
            'user-guide/plugins/devtron-cd-trigger',
            'user-guide/plugins/devtron-ci-trigger',
            'user-guide/plugins/devtron-job-trigger',
            'user-guide/plugins/docker-slim',
            'user-guide/plugins/eks-create-cluster',
            'user-guide/plugins/gcs-create-bucket',
            'user-guide/plugins/github-pull-request-updater',
            'user-guide/plugins/gke-provisioner',
            'user-guide/plugins/golang-migrate',
            'user-guide/plugins/jenkins',
            'user-guide/plugins/jira-validator',
            'user-guide/plugins/jira-updater',
            'user-guide/plugins/k6-load-testing',
            'user-guide/plugins/pull-images-from-container-repository',
            'user-guide/plugins/semgrep',
            'user-guide/plugins/sonarqube',
            'user-guide/plugins/sonarqube-v1.1.0',
            'user-guide/plugins/terraform-cli',
            'user-guide/plugins/vulnerability-scanning',
          ],
        },

        'user-guide/devtron-intelligence',
        'user-guide/creating-application/fluxcd',

        {
          type: 'category',
          label: 'Use Cases',
          collapsed: true,
          link: {
            type: 'doc', // or 'generated-index'
            id: 'user-guide/use-cases/README',
          },
          items: [
            'user-guide/use-cases/devtron-generic-helm-chart-to-run-cron-job-or-one-time-job',
            'user-guide/use-cases/connect-springboot-with-mysql-database',
            'user-guide/use-cases/connect-expressjs-with-mongodb-database',
            'user-guide/use-cases/connect-django-with-mysql-database',
            'user-guide/use-cases/oci-pull',
          ],
        },
        'user-guide/telemetry',
        'reference/graviton',
        {
          type: 'link',
          label: 'Release Notes',
          href: 'https://github.com/devtron-labs/devtron/releases',
        },
        'setup/install/uninstall-devtron',
      ],
    },
  ],
};

export default sidebars;