backstage/microsite/sidebars.json

{
  "docs": {
    "Overview": [
      "overview/what-is-backstage",
      "overview/architecture-overview",
      "overview/roadmap",
      "overview/vision",
      "overview/background",
      "overview/adopting",
      "overview/stability-index",
      "overview/logos"
    ],
    "Getting Started": [
      "getting-started/index",
      "getting-started/running-backstage-locally",
      "getting-started/installation",
      "getting-started/development-environment",
      "getting-started/create-an-app",
      {
        "type": "subcategory",
        "label": "App configuration",
        "ids": [
          "getting-started/configure-app-with-plugins",
          "getting-started/app-custom-theme"
        ]
      },
      {
        "type": "subcategory",
        "label": "Deployment",
        "ids": [
          "getting-started/deployment-k8s",
          "getting-started/deployment-helm",
          "getting-started/deployment-other"
        ]
      }
    ],
    "CLI": ["cli/index", "cli/commands"],
    "Core Features": [
      {
        "type": "subcategory",
        "label": "Kubernetes",
        "ids": ["features/kubernetes/overview"]
      },
      {
        "type": "subcategory",
        "label": "Software Catalog",
        "ids": [
          "features/software-catalog/software-catalog-overview",
          "features/software-catalog/installation",
          "features/software-catalog/configuration",
          "features/software-catalog/system-model",
          "features/software-catalog/descriptor-format",
          "features/software-catalog/references",
          "features/software-catalog/well-known-annotations",
          "features/software-catalog/well-known-relations",
          "features/software-catalog/extending-the-model",
          "features/software-catalog/external-integrations",
          "features/software-catalog/kubernetes-in-backstage",
          "features/software-catalog/software-catalog-api"
        ]
      },
      {
        "type": "subcategory",
        "label": "Software Templates",
        "ids": [
          "features/software-templates/software-templates-index",
          "features/software-templates/installation",
          "features/software-templates/adding-templates",
          "features/software-templates/extending/extending-index",
          "features/software-templates/extending/extending-templater",
          "features/software-templates/extending/extending-publisher",
          "features/software-templates/extending/extending-preparer"
        ]
      },
      {
        "type": "subcategory",
        "label": "Backstage Search",
        "ids": [
          "features/search/search-overview",
          "features/search/architecture"
        ]
      },
      {
        "type": "subcategory",
        "label": "TechDocs",
        "ids": [
          "features/techdocs/techdocs-overview",
          "features/techdocs/getting-started",
          "features/techdocs/concepts",
          "features/techdocs/architecture",
          "features/techdocs/creating-and-publishing",
          "features/techdocs/configuration",
          "features/techdocs/using-cloud-storage",
          "features/techdocs/configuring-ci-cd",
          "features/techdocs/how-to-guides",
          "features/techdocs/troubleshooting",
          "features/techdocs/faqs"
        ]
      }
    ],
    "Plugins": [
      "plugins/index",
      "plugins/existing-plugins",
      "plugins/create-a-plugin",
      "plugins/plugin-development",
      "plugins/structure-of-a-plugin",
      "plugins/integrating-plugin-into-service-catalog",
      "plugins/composability",
      {
        "type": "subcategory",
        "label": "Backends and APIs",
        "ids": [
          "plugins/proxying",
          "plugins/backend-plugin",
          "plugins/call-existing-api"
        ]
      },
      {
        "type": "subcategory",
        "label": "Testing",
        "ids": ["plugins/testing"]
      },
      {
        "type": "subcategory",
        "label": "Publishing",
        "ids": [
          "plugins/publishing",
          "plugins/publish-private",
          "plugins/add-to-marketplace"
        ]
      }
    ],
    "Configuration": [
      "conf/index",
      "conf/reading",
      "conf/writing",
      "conf/defining"
    ],
    "Auth and identity": [
      "auth/index",
      "auth/add-auth-provider",
      "auth/auth-backend",
      "auth/oauth",
      "auth/glossary",
      "auth/auth-backend-classes"
    ],

    "Designing for Backstage": [
      "dls/design",
      "dls/contributing-to-storybook",
      "dls/figma"
    ],
    "API references": [
      {
        "type": "subcategory",
        "label": "TypeScript API",
        "ids": [
          "api/utility-apis",
          "reference/utility-apis/README",
          "reference/createPlugin",
          "reference/createPlugin-feature-flags",
          "reference/createPlugin-router"
        ]
      },
      {
        "type": "subcategory",
        "label": "Backend APIs",
        "ids": ["api/backend"]
      }
    ],
    "Tutorials": [
      "tutorials/journey",
      "tutorials/quickstart-app-auth",
      "tutorials/quickstart-app-plugin"
    ],
    "Architecture Decision Records (ADRs)": [
      "architecture-decisions/adrs-overview",
      "architecture-decisions/adrs-adr001",
      "architecture-decisions/adrs-adr002",
      "architecture-decisions/adrs-adr003",
      "architecture-decisions/adrs-adr004",
      "architecture-decisions/adrs-adr005",
      "architecture-decisions/adrs-adr006",
      "architecture-decisions/adrs-adr007",
      "architecture-decisions/adrs-adr008",
      "architecture-decisions/adrs-adr009",
      "architecture-decisions/adrs-adr010"
    ],
    "Contribute": ["../CONTRIBUTING"],
    "Support": ["support/support", "support/project-structure"],
    "Glossary": ["glossary"],
    "FAQ": ["FAQ"]
  }
}