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 = {
  docsSidebar: [
    'index',
    'installing-stackql',
    {
      type: 'category',
      label: 'Getting Started',
      items: [
        'getting-started/resource-hierarchy',
        'getting-started/using-stackql',
        'getting-started/using-a-provider',
        'getting-started/output-modes',
        'getting-started/variables',
        'getting-started/templating',
      ]
    },
    {
      type: 'category',
      label: 'Command Line Usage',
      items: [
        'command-line-usage/exec',
        'command-line-usage/shell',
        'command-line-usage/srv',
        'command-line-usage/registry',
        'command-line-usage/global-flags',
      ]
    },
    {
      type: 'category',
      label: 'Language Specification',
      items: [
        'language-spec/select',
        'language-spec/insert',
        'language-spec/update',
        'language-spec/replace',
        'language-spec/delete',
        'language-spec/show',
        'language-spec/describe',
        'language-spec/exec',
        'language-spec/createview',
        'language-spec/refreshview',
        'language-spec/dropview',        
        'language-spec/registry',
        {
          type: 'category',
          label: 'Functions',
          items: [{type: 'autogenerated', dirName: 'language-spec/functions'}]
        },        
        'language-spec/lexical-structure',
        'language-spec/data-types',
        'language-spec/keywords',
        'language-spec/utility-commands',
      ]
    },  
    {
      type: 'category',
      label: 'Developers',
      items: [{type: 'autogenerated', dirName: 'developers'}]
    },
    {
      type: 'link',
      label: 'Provider Registry',
      href: '/registry',
    },
    {
      type: 'link',
      label: 'stackql-deploy',
      href: '/stackql-deploy',
    },    
    {
      type: 'category',
      label: 'GitHub Actions',
      items: [
        {
          type: 'link',
          label: 'stackql-deploy',
          href: 'https://github.com/marketplace/actions/stackql-deploy',
        },
        {
          type: 'link',
          label: 'setup-stackql',
          href: 'https://github.com/marketplace/actions/setup-stackql',
        },
        {
          type: 'link',
          label: 'stackql-exec',
          href: 'https://github.com/marketplace/actions/stackql-exec',
        },
        {
          type: 'link',
          label: 'stackql-assert',
          href: 'https://github.com/marketplace/actions/stackql-assert',
        },
      ]
    },
    {
      type: 'category',
      label: 'Docker Images',
      items: [
        {
          type: 'link',
          label: 'stackql/stackql',
          href: 'https://hub.docker.com/r/stackql/stackql',
        },
        {
          type: 'link',
          label: 'stackql/stackql-jupyter-demo',
          href: 'https://hub.docker.com/r/stackql/stackql-jupyter-demo',
        },
        {
          type: 'link',
          label: 'stackql/stackql-playground',
          href: 'https://hub.docker.com/r/stackql/stackql-playground',
        },
      ]
    },        
    {
      type: 'category',
      label: 'Python Packages',
      items: [
        {
          type: 'link',
          label: 'pystackql',
          href: 'https://pystackql.readthedocs.io/en/latest/',
        },
        {
          type: 'link',
          label: 'stackql-deploy',
          href: 'https://pypi.org/project/stackql-deploy/',
        },        
      ]
    },
    {
      type: 'category',
      label: 'Cookbooks',
      link: {
        type: 'generated-index',
        title: 'StackQL Cookbooks and Recipes',
        description: 'StackQL quick starts, how-tos, practical examples and use cases',
        slug: '/stackql-cookbooks',
        keywords: ['quickstarts', 'guides', 'how-tos', 'examples', 'use cases'],
        image: '/img/stackql-cover.png',
      },
      items: [
        {
          type: 'category',
          label: 'AWS',
          description: 'Practical examples and use cases specific to AWS',
          link: {
            type: 'generated-index',
            title: 'AWS Cookbooks',
            description: 'Practical examples and use cases specific to AWS',
            slug: '/stackql-cookbooks/aws',
          },
          items: [{ type: 'autogenerated', dirName: 'cookbooks/aws' }],
        },
        {
          type: 'category',
          label: 'Microsoft Azure',
          description: 'Practical examples and use cases specific to Azure',
          link: {
            type: 'generated-index',
            title: 'Azure Cookbooks',
            description: 'Practical examples and use cases specific to Azure',
            slug: '/stackql-cookbooks/azure',
            
          },
          items: [{ type: 'autogenerated', dirName: 'cookbooks/azure' }],
        },
        {
          type: 'category',
          label: 'Google Cloud Platform',
          description: 'Practical examples and use cases specific to Google Cloud',
          link: {
            type: 'generated-index',
            title: 'Google Cookbooks',
            description: 'Practical examples and use cases specific to Google Cloud',
            slug: '/stackql-cookbooks/google',
          },
          items: [{ type: 'autogenerated', dirName: 'cookbooks/google' }],
        },
        {
          type: 'category',
          label: 'GitHub',
          description: 'Practical examples and use cases specific to GitHub',
          link: {
            type: 'generated-index',
            title: 'GitHub Cookbooks',
            description: 'Practical examples and use cases specific to GitHub',
            slug: '/stackql-cookbooks/github',
          },
          items: [{ type: 'autogenerated', dirName: 'cookbooks/github' }],
        },        
      ],
    },
    {
      type: 'link',
      label: 'Blog',
      href: '/blog',
    },
    {
      type: 'link',
      label: 'Downloads',
      href: '/downloads',
    },    
  ],
};

module.exports = sidebars;