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

  getting_started: [
    {
      type: "category",
      label: "Overview",
      collapsed: false,
      items: [
        "getting-started/what-is-iomete",
        "getting-started/platform-tour",
        "getting-started/architecture",
        "getting-started/scalability",
        "getting-started/support",
      ],
    },
    {
      type: "category",
      label: "Deployment",
      collapsed: false,
      items: [
        "deployment/on-prem/install",
        "deployment/on-prem/release-notes",
        {
          type: "category",
          label: "Advanced Settings",
          collapsed: true,
          items: [
            "deployment/minio-deployment",
            "deployment/configure-ingress",
            "deployment/configure-custom-dns",
            "deployment/backend-databases",
            "deployment/postgresql-deployment",
            "deployment/mysql-deployment",
            "deployment/life-cycle-management",
            "deployment/truststore",
            "deployment/network-policies",
            "deployment/connect-namespace",
          ],
        },
      ],
    },
    {
      type: "category",
      label: "Community Deployment",
      collapsed: false,
      items: [
        "community-deployment/overview",
        {
          type: "category",
          label: "AWS",
          collapsed: true,
          items: [
            "community-deployment/aws/install",
            "community-deployment/aws/permissions",
            "community-deployment/aws/aws-advanced-settings",
            "community-deployment/aws/troubleshooting",
            "community-deployment/aws/data-plane-cost",
            "community-deployment/aws/changelog",
            "community-deployment/aws/uninstall",
          ],
        },
        {
          type: "category",
          label: "Azure",
          collapsed: true,
          items: ["community-deployment/azure/install"],
        },
        {
          type: "category",
          label: "GCP",
          collapsed: true,
          items: [
            "community-deployment/gcp/install",
            "community-deployment/gcp/uninstall",
          ],
        },
      ],
    },
  ],

  guides: [
    {
      type: "category",
      label: "User Guide",
      collapsed: false,
      items: [
        "user-guide/virtual-lakehouses",
        "user-guide/spark-connect",
        "user-guide/spark-jobs",
        "user-guide/sql-editor",
        "user-guide/data-catalog",
        "user-guide/create-a-personal-access-token",
        "user-guide/global-spark-settings",
        "user-guide/private-docker-registry",
        "user-guide/email-settings",
        "user-guide/node-types",
        "user-guide/node-type-sizing",
        "user-guide/volumes",
        "user-guide/secrets",
        "user-guide/api-reference",
      ],
    },
    {
      type: "category",
      label: "Identity and Account ",
      collapsed: false,
      items: [
        "user-guide/iam/users",
        "user-guide/iam/groups",
        "user-guide/iam/roles",
        "user-guide/iam/ldap-configuration",
        {
          type: "category",
          label: "SSO Configuration",
          collapsed: false,
          items: [
            "user-guide/iam/sso/sso",
            "user-guide/iam/sso/sso-saml",
            "user-guide/iam/sso/sso-oidc",
            "user-guide/iam/sso/sso-okta",
            "user-guide/iam/sso/sso-onelogin",
            "user-guide/iam/sso/sso-entra-id",
            "user-guide/iam/sso/scim",
            "user-guide/iam/sso/scim-okta",
          ],
        },
      ],
    },
    {
      type: "category",
      label: "Spark Catalogs ",
      collapsed: false,
      items: [
        "user-guide/spark-catalogs/overview",
        "user-guide/spark-catalogs/internal",
        {
          type: "category",
          label: "External Catalogs",
          collapsed: false,
          items: [
            "user-guide/spark-catalogs/external-jdbc",
            "user-guide/spark-catalogs/external-rest",
            "user-guide/spark-catalogs/external-glue",
            "user-guide/spark-catalogs/external-nessie",
          ],
        },
      ],
    },
    {
      type: "category",
      label: "Data Sources",
      collapsed: false,
      items: [
        "reference/data-sources/jdbc-sources",
        "reference/data-sources/snowflake-connector",
        "reference/data-sources/csv-files",
        "reference/data-sources/json-files",
        "reference/data-sources/parquet-files",
        "reference/data-sources/orc-files",
      ],
    },
    {
      type: "category",
      label: "Data Security",
      collapsed: false,
      items: [
        "user-guide/data-security/overview",
        "user-guide/data-security/access-policy",
        "user-guide/data-security/data-masking",
        "user-guide/data-security/row-level-filter",
        "user-guide/data-security/tag-based-access-policy",
        "user-guide/data-security/tag-based-data-masking",
        "user-guide/data-security/data-security-api",
      ],
    },
    {
      type: "category",
      label: "Spark Jobs",
      collapsed: false,
      items: [
        "developer-guide/spark-job/getting-started",
        "developer-guide/spark-job/spark-application-config",
        "developer-guide/spark-job/iomete-sdk",
        "developer-guide/spark-job/airflow",
        "developer-guide/spark-job/nessie-integration",
        "developer-guide/spark-job/spark-logging",
      ],
    },
    {
      type: "category",
      label: "Jupyter Notebook",
      collapsed: false,
      items: [
        "developer-guide/notebook/starting-with-notebook",
        "developer-guide/notebook/using-vscode",
      ],
    },
    {
      type: "category",
      label: "Client & Libraries",
      collapsed: false,
      items: [
        "developer-guide/driver/sql-alchemy-driver",
        "developer-guide/driver/jdbc-driver",
      ],
    },
    {
      type: "category",
      label: "AWS",
      collapsed: false,
      items: ["aws/s3-bucket-permissions", "aws/glue-catalog-permissions"],
    },
    {
      type: "category",
      label: "GCP",
      collapsed: false,
      items: ["gcp/gcs-bucket-permissions"],
    },
    {
      type: "category",
      label: "Kubernetes",
      collapsed: false,
      items: [
        "k8s/private-docker-registry",
        "k8s/spark-executor-shuffle-storage-options",
        "k8s/sizing-nodes-in-kubernetes-for-iomete-installation",
        "k8s/cpu-vs-vcpu",
        "k8s/monitoring",
      ],
    },
    {
      type: "category",
      label: "Misc",
      collapsed: false,
      items: [
        "user-guide/misc/datagrip-lakehouse-connection",
        "user-guide/misc/shutdown-for-maintenance",
        "user-guide/misc/troubleshooting-lakehouse-oom",
      ],
    },
  ],
  integrations: [
    {
      type: "category",
      label: "DBT",
      collapsed: false,
      items: [
        "integrations/dbt/getting-started-with-iomete-dbt",
        "integrations/dbt/dbt-materializations",
        "integrations/dbt/dbt-incremental-models",
        "integrations/dbt/dbt-incremental-models-by-examples",
      ],
    },
    {
      type: "category",
      label: "BI Integrations",
      collapsed: false,
      items: [
        "integrations/bi/metabase",
        "integrations/bi/apache-superset",
        "integrations/bi/power-bi",
        "integrations/bi/power-bi-odbc",
        "integrations/bi/power-bi-arrow-flight",
        "integrations/bi/tableau",
        "integrations/bi/redash",
      ],
    },
    {
      type: "category",
      label: "DB Tools",
      collapsed: false,
      items: ["integrations/dbtools/dbeaver"],
    },
    {
      type: "category",
      label: "Git",
      collapsed: false,
      items: ["integrations/git/git-integration"],
    },
  ],

  reference: [
    {
      type: "category",
      label: "SQL Quick Start",
      collapsed: false,
      items: [
        "reference/sql-quick-start/sql-ddl-examples",
        "reference/sql-quick-start/dml-operations",
        "reference/sql-quick-start/iceberg-advanced-features",
        "reference/sql-quick-start/tables-from-jdbc-csv-json",
        "reference/sql-quick-start/query-federation",
        "reference/sql-quick-start/ms-sql-server-datasource",
        "reference/sql-quick-start/oracle-datasource",
      ],
    },
    {
      type: "category",
      label: "Iceberg Tables",
      collapsed: false,
      items: [
        "reference/iceberg-tables/getting-started",
        "reference/iceberg-tables/ddl",
        "reference/iceberg-tables/queries",
        "reference/iceberg-tables/writes",
        "reference/iceberg-tables/iceberg-procedures",
        "reference/iceberg-tables/time-travel",
        "reference/iceberg-tables/maintenance",
      ],
    },
    {
      type: "category",
      label: "Spark SQL Reference",
      collapsed: false,
      items: [
        {
          type: "category",
          label: "DDL",
          collapsed: true,
          items: [
            "reference/spark-sql/ddl/create-database",
            "reference/spark-sql/ddl/alter-database",
            "reference/spark-sql/ddl/drop-database",
            "reference/spark-sql/ddl/create-table",
            "reference/spark-sql/ddl/alter-table",
            // 'reference/spark-sql/ddl/drop-table',
            "reference/spark-sql/ddl/create-view",
            // "reference/spark-sql/ddl/sql-ddl-examples",
            // 'reference/spark-sql/ddl/drop-view'
          ],
        },
        {
          type: "category",
          label: "Writes",
          collapsed: true,
          items: [
            "reference/spark-sql/writes/truncate-table",
            "reference/spark-sql/writes/insert-into",
            "reference/spark-sql/writes/merge-into",
            "reference/spark-sql/writes/insert-overwrite",
          ],
        },
        {
          type: "category",
          label: "Queries",
          collapsed: true,
          items: [
            "reference/spark-sql/queries/select",
            "reference/spark-sql/queries/cte",
            "reference/spark-sql/queries/cluster-by-clause",
            "reference/spark-sql/queries/distribute-by-clause",
            "reference/spark-sql/queries/group-by-clause",
            "reference/spark-sql/queries/having-by-clause",
            "reference/spark-sql/queries/hints",
            "reference/spark-sql/queries/inline-table",
            "reference/spark-sql/queries/file",
            "reference/spark-sql/queries/join",
            "reference/spark-sql/queries/like-predicate",
            "reference/spark-sql/queries/limit-clause",
            "reference/spark-sql/queries/order-by-clause",
            "reference/spark-sql/queries/set-operators",
            "reference/spark-sql/queries/sort-by-clause",
            "reference/spark-sql/queries/sampling-queries",
            "reference/spark-sql/queries/table-valued-functions",
            "reference/spark-sql/queries/use-database",
            "reference/spark-sql/queries/where-clause",
            "reference/spark-sql/queries/window-functions",
            "reference/spark-sql/queries/case-clause",
            "reference/spark-sql/queries/pivot-clause",
            "reference/spark-sql/queries/lateral-view-clause",
            "reference/spark-sql/queries/transform",
          ],
        },
        "reference/spark-sql/cache",
        "reference/spark-sql/column-types",
        "reference/spark-sql/datetime-patterns",
        "reference/spark-sql/identifiers",
        "reference/spark-sql/operators",
        "reference/spark-sql/literals",
        "reference/spark-sql/null-semantics",
        "reference/spark-sql/functions",
      ],
    },
    {
      type: "category",
      label: "Pyspark",
      collapsed: false,
      items: ["reference/pyspark/pyspark-join"],
    },
    {
      type: "category",
      label: "Open Source Spark Jobs",
      collapsed: false,
      items: [
        "open-source-spark-jobs/getting-started",
        "open-source-spark-jobs/data-compaction-job",
        "open-source-spark-jobs/query-scheduler-job",
        "open-source-spark-jobs/catalog-sync-job",
        "open-source-spark-jobs/mysql-database-replication-job",
        "open-source-spark-jobs/kafka-streaming",
        "open-source-spark-jobs/file-streaming",
        "open-source-spark-jobs/ingesting-jobs",
      ],
    },
  ],

  tutorials: [
    {
      type: "category",
      label: "Generic",
      collapsed: false,
      items: [
        "tutorials/sync-data-from-jdbc-sources",
        "tutorials/export-as-a-csv-file",
      ],
    },
    {
      type: "category",
      label: "AWS",
      collapsed: false,
      items: ["aws/read-files-from-aws-s3"],
    },
    {
      type: "category",
      label: "Iceberg",
      collapsed: false,
      items: ["tutorials/compaction-cow-mor"],
    },
  ],
};

export default sidebars;