constellation/docs/sidebars.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.
 */

// @ts-check

/** @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
  docs: [
    {
      type: 'doc',
      label: 'Introduction',
      id: 'intro'
    },
    {
      type: 'category',
      label: 'Basics',
      link: {
        type: 'generated-index',
      },
      items: [
        {
          type: 'doc',
          label: 'Confidential Kubernetes',
          id: 'overview/confidential-kubernetes',
        },
        {
          type: 'doc',
          label: 'Security benefits',
          id: 'overview/security-benefits',
        },
        {
          type: 'doc',
          label: 'Product features',
          id: 'overview/product',
        },
        {
          type: 'doc',
          label: 'Feature status of clouds',
          id: 'overview/clouds',
        },
        {
          type: 'category',
          label: 'Performance',
          link: { type: 'doc', id: 'overview/performance/performance' },
          items: [
            {
              type: 'doc',
              label: 'I/O benchmarks',
              id: 'overview/performance/io',
            },
            {
              type: 'doc',
              label: 'Application benchmarks',
              id: 'overview/performance/application',
            },
          ]
        },
        {
          type: 'doc',
          label: 'License',
          id: 'overview/license',
        },
      ]
    },
    {
      type: 'category',
      label: 'Getting started',
      link: {
        type: 'generated-index',
      },
      items: [
        {
          type: 'doc',
          label: 'Installation',
          id: 'getting-started/install',
        },
        {
          type: 'doc',
          label: 'First steps (cloud)',
          id: 'getting-started/first-steps',
        },
        {
          type: 'doc',
          label: 'First steps (local)',
          id: 'getting-started/first-steps-local',
        },
        {
          type: 'category',
          label: 'Examples',
          link: {
            type: 'doc',
            id: 'getting-started/examples',
          },
          items: [
            {
              type: 'doc',
              label: 'Emojivoto',
              id: 'getting-started/examples/emojivoto'
            },
            {
              type: 'doc',
              label: 'Online Boutique',
              id: 'getting-started/examples/online-boutique'
            },
            {
              type: 'doc',
              label: 'Horizontal Pod Autoscaling',
              id: 'getting-started/examples/horizontal-scaling'
            },
            {
              type: 'doc',
              label: 'Filestash with s3proxy',
              id: 'getting-started/examples/filestash-s3proxy'
            },
          ]
        },
      ],
    },
    {
      type: 'category',
      label: 'Workflows',
      link: {
        type: 'generated-index',
      },
      items: [
        {
          type: 'doc',
          label: 'Verify the CLI',
          id: 'workflows/verify-cli',
        },
        {
          type: 'doc',
          label: 'Configure your cluster',
          id: 'workflows/config',
        },
        {
          type: 'doc',
          label: 'Create your cluster',
          id: 'workflows/create',
        },
        {
          type: 'doc',
          label: 'Scale your cluster',
          id: 'workflows/scale',
        },
        {
          type: 'doc',
          label: 'Upgrade your cluster',
          id: 'workflows/upgrade',
        },
        {
          type: 'doc',
          label: 'Expose a service',
          id: 'workflows/lb',
        },
        {
          type: 'doc',
          label: 'Install cert-manager',
          id: 'workflows/cert-manager',
        },
        {
          type: 'doc',
          label: 'Install s3proxy',
          id: 'workflows/s3proxy',
        },
        {
          type: 'doc',
          label: 'Terminate your cluster',
          id: 'workflows/terminate',
        },
        {
          type: 'doc',
          label: 'Recover your cluster',
          id: 'workflows/recovery',
        },
        {
          type: 'doc',
          label: 'Verify your cluster',
          id: 'workflows/verify-cluster',
        },
        {
          type: 'doc',
          label: 'Use persistent storage',
          id: 'workflows/storage',
        },
        {
          type: 'doc',
          label: 'Use the Terraform module',
          id: 'workflows/terraform-module',
        },
        // {
        //   type: 'doc',
        //   label: 'Use Azure trusted launch VMs',
        //   id: 'workflows/trusted-launch',
        // },
        {
          type: 'doc',
          label: 'Consume SBOMs',
          id: 'workflows/sbom',
        },
        {
          type: 'doc',
          label: 'Troubleshooting',
          id: 'workflows/troubleshooting',
        },
      ],
    },
    {
      type: 'category',
      label: 'Architecture',
      link: {
        type: 'generated-index',
      },
      items: [
        {
          type: 'doc',
          label: 'Overview',
          id: 'architecture/overview',
        },
        {
          type: 'doc',
          label: 'Cluster orchestration',
          id: 'architecture/orchestration',
        },
        {
          type: 'doc',
          label: 'Versions and support',
          id: 'architecture/versions',
        },
        {
          type: 'doc',
          label: 'Microservices',
          id: 'architecture/microservices',
        },
        {
          type: 'doc',
          label: 'Attestation',
          id: 'architecture/attestation',
        },
        {
          type: 'doc',
          label: 'Images',
          id: 'architecture/images',
        },
        {
          type: 'doc',
          label: 'Keys and cryptographic primitives',
          id: 'architecture/keys',
        },
        {
          type: 'doc',
          label: 'Encrypted persistent storage',
          id: 'architecture/encrypted-storage',
        },
        {
          type: 'doc',
          label: 'Networking',
          id: 'architecture/networking',
        },
        {
          type: 'doc',
          label: 'Observability',
          id: 'architecture/observability',
        },
      ],
    },
    {
      type: 'category',
      label: 'Reference',
      link: {
        type: 'generated-index',
      },
      items: [
        {
          type: 'doc',
          label: 'CLI',
          id: 'reference/cli',
        },
        {
          type: 'doc',
          label: 'Configuration migrations',
          id: 'reference/migration',
        },
        {
          type: 'doc',
          label: 'Terraform usage',
          id: 'reference/terraform',
        },
        {
          type: 'doc',
          label: 'SLSA adoption',
          id: 'reference/slsa',
        },
      ],
    },
  ],
};

module.exports = sidebars;