From 03faba4e0fbb9ad83a7ce80a14b77133d20375bb Mon Sep 17 00:00:00 2001 From: josh-wong Date: Tue, 14 Nov 2023 11:12:12 +0900 Subject: [PATCH] Update side navigation Update titles in the side navigation for consistency (title-style capitalization and to match actual doc titles), and add missing docs. --- _data/navigation.yml | 138 ++++++++++++++++++++++++------------------- 1 file changed, 76 insertions(+), 62 deletions(-) diff --git a/_data/navigation.yml b/_data/navigation.yml index 7785f866..8e828030 100644 --- a/_data/navigation.yml +++ b/_data/navigation.yml @@ -97,9 +97,9 @@ versions: # Develop docs - title: "Develop" children: - - title: "Add ScalarDB to your build" + - title: "Add ScalarDB to Your Build" url: /docs/latest/add-scalardb-to-your-build/ - - title: "Add ScalarDB SQL to your build" + - title: "Add ScalarDB SQL to Your Build" url: /docs/latest/scalardb-sql/add-scalardb-sql-to-your-build/ - title: "Developer Guides for ScalarDB" url: /docs/latest/guides/ @@ -107,13 +107,17 @@ versions: url: /docs/latest/development-configurations/ - title: "ScalarDB Schema Loader" url: /docs/latest/schema-loader/ + - title: "ScalarDB FDW" + url: /docs/latest/scalardb-analytics-postgresql/scalardb-fdw/ + - title: "Schema Importer" + url: /docs/latest/scalardb-analytics-postgresql/schema-importer/ # - title: "Export Function for ScalarDB Data Loader" # May be added in the near future. # url: /docs/latest/scalardb-data-loader/getting-started-export/ # - title: "Import Function for ScalarDB Data Loader" # May be added in the near future. # url: /docs/latest/scalardb-data-loader/getting-started-import/ - title: "How to Run ScalarDB GraphQL Server" url: /docs/latest/scalardb-graphql/how-to-run-server/ - - title: "How to Run Two-Phase Commit Transaction" + - title: "How to Run Two-Phase Commit Transaction by Using ScalarDB GraphQL" url: /docs/latest/scalardb-graphql/how-to-run-two-phase-commit-transaction/ - title: "ScalarDB SQL Command Line Interface" url: /docs/latest/scalardb-sql/command-line-interface/ @@ -126,13 +130,13 @@ versions: url: /docs/latest/helm-charts/getting-started-scalar-helm-charts/ - title: "Set Up ScalarDB Cluster on Kubernetes by Using a Helm Chart" url: /docs/latest/scalardb-cluster/setup-scalardb-cluster-on-kubernetes-by-using-helm-chart/ - - title: "Configure a custom values file for Scalar Helm Charts" + - title: "Configure a Custom Values File for Scalar Helm Charts" url: /docs/latest/helm-charts/configure-custom-values-file/ - - title: "Deploy Scalar products using Scalar Helm Charts" + - title: "Deploy Scalar Products Using Scalar Helm Charts" url: /docs/latest/helm-charts/how-to-deploy-scalar-products/ - - title: "Mount any files or volumes on Scalar product pods" + - title: "Mount Any Files or Volumes on Scalar Product Pods" url: /docs/latest/helm-charts/mount-files-or-volumes-on-scalar-pods/ - - title: "How to use Secret resources to pass the credentials as the environment variables into the properties file" + - title: "How to Use Secret Resources to Pass Credentials as Environment Variables into the Properties File" url: /docs/latest/helm-charts/use-secret-for-credentials/ - title: "How to Install ScalarDB Analytics with PostgreSQL in Your Local Environment by Using Docker" url: /docs/latest/scalardb-analytics-postgresql/installation/ @@ -143,7 +147,7 @@ versions: # Manage docs - title: "Manage" children: - - title: "How to Backup and Restore Databases Used Through ScalarDB" + - title: "How to Back Up and Restore Databases Used Through ScalarDB" url: /docs/latest/backup-restore/ - title: "Managing ScalarDB on Managed Kubernetes Services" url: /docs/latest/scalar-kubernetes/manage-kubernetes/ @@ -159,9 +163,9 @@ versions: url: /docs/latest/design/ - title: "ScalarDB Supported Databases" url: /docs/latest/scalardb-supported-databases/ - - title: "Requirements in the Underlying Databases of ScalarDB" + - title: "Requirements and Recommendations for the Underlying Databases of ScalarDB" url: /docs/latest/requirements/ - - title: "Storage Abstraction" + - title: "Storage Abstraction and API Guide" url: /docs/latest/storage-abstraction/ - title: "ScalarDB Benchmarks" url: /docs/latest/scalardb-benchmarks/README/ @@ -235,9 +239,9 @@ versions: # Develop docs - title: "Develop" children: - - title: "Add ScalarDB to your build" + - title: "Add ScalarDB to Your Build" url: /docs/3.9/add-scalardb-to-your-build/ - - title: "Add ScalarDB SQL to your build" + - title: "Add ScalarDB SQL to Your Build" url: /docs/3.9/scalardb-sql/add-scalardb-sql-to-your-build/ - title: "Developer Guides for ScalarDB" url: /docs/3.9/guides/ @@ -245,13 +249,17 @@ versions: url: /docs/3.9/development-configurations/ - title: "ScalarDB Schema Loader" url: /docs/3.9/schema-loader/ + - title: "ScalarDB FDW" + url: /docs/3.9/scalardb-analytics-postgresql/scalardb-fdw/ + - title: "Schema Importer" + url: /docs/3.9/scalardb-analytics-postgresql/schema-importer/ # - title: "Export Function for ScalarDB Data Loader" # May be added in the near future. # url: /docs/3.9/scalardb-data-loader/getting-started-export/ # - title: "Import Function for ScalarDB Data Loader" # May be added in the near future. # url: /docs/3.9/scalardb-data-loader/getting-started-import/ - title: "How to Run ScalarDB GraphQL Server" url: /docs/3.9/scalardb-graphql/how-to-run-server/ - - title: "How to Run Two-Phase Commit Transaction" + - title: "How to Run Two-Phase Commit Transaction by Using ScalarDB GraphQL" url: /docs/3.9/scalardb-graphql/how-to-run-two-phase-commit-transaction/ - title: "ScalarDB SQL Command Line Interface" url: /docs/3.9/scalardb-sql/command-line-interface/ @@ -264,13 +272,13 @@ versions: url: /docs/3.9/helm-charts/getting-started-scalar-helm-charts/ - title: "Set Up ScalarDB Cluster on Kubernetes by Using a Helm Chart" url: /docs/3.9/scalardb-cluster/setup-scalardb-cluster-on-kubernetes-by-using-helm-chart/ - - title: "Configure a custom values file for Scalar Helm Charts" + - title: "Configure a Custom Values File for Scalar Helm Charts" url: /docs/3.9/helm-charts/configure-custom-values-file/ - - title: "Deploy Scalar products using Scalar Helm Charts" + - title: "Deploy Scalar Products Using Scalar Helm Charts" url: /docs/3.9/helm-charts/how-to-deploy-scalar-products/ - - title: "Mount any files or volumes on Scalar product pods" + - title: "Mount Any Files or Volumes on Scalar Product Pods" url: /docs/3.9/helm-charts/mount-files-or-volumes-on-scalar-pods/ - - title: "How to use Secret resources to pass the credentials as the environment variables into the properties file" + - title: "How to Use Secret Resources to Pass Credentials as Environment Variables into the Properties File" url: /docs/3.9/helm-charts/use-secret-for-credentials/ - title: "How to Install ScalarDB Analytics with PostgreSQL in Your Local Environment by Using Docker" url: /docs/3.9/scalardb-analytics-postgresql/installation/ @@ -281,7 +289,7 @@ versions: # Manage docs - title: "Manage" children: - - title: "How to Backup and Restore Databases Used Through ScalarDB" + - title: "How to Back Up and Restore Databases Used Through ScalarDB" url: /docs/3.9/backup-restore/ - title: "Managing ScalarDB on Managed Kubernetes Services" url: /docs/3.9/scalar-kubernetes/manage-kubernetes/ @@ -297,9 +305,9 @@ versions: url: /docs/3.9/design/ - title: "ScalarDB Supported Databases" url: /docs/3.9/scalardb-supported-databases/ - - title: "Requirements in the Underlying Databases of ScalarDB" + - title: "Requirements and Recommendations for the Underlying Databases of ScalarDB" url: /docs/3.9/requirements/ - - title: "Storage Abstraction" + - title: "Storage Abstraction and API Guide" url: /docs/3.9/storage-abstraction/ - title: "ScalarDB Benchmarks" url: /docs/3.9/scalardb-benchmarks/README/ @@ -377,7 +385,7 @@ versions: # Develop docs - title: "Develop" children: - - title: "Add ScalarDB to your build" + - title: "Add ScalarDB to Your Build" url: /docs/3.8/add-scalardb-to-your-build/ - title: "Developer Guides for ScalarDB" url: /docs/3.8/guides/ @@ -389,7 +397,7 @@ versions: url: /docs/3.8/scalardb-data-loader/getting-started-export/ - title: "Import Function for ScalarDB Data Loader" url: /docs/3.8/scalardb-data-loader/getting-started-import/ - - title: "How to Run Two-Phase Commit Transaction" + - title: "How to Run Two-Phase Commit Transaction by Using ScalarDB GraphQL" url: /docs/3.8/scalardb-graphql/how-to-run-two-phase-commit-transaction/ - title: "How to Run ScalarDB GraphQL Server" url: /docs/3.8/scalardb-graphql/how-to-run-server/ @@ -408,13 +416,13 @@ versions: url: /docs/3.8/scalardb-server/ - title: "Getting Started with Helm Charts (ScalarDB Server)" url: /docs/3.8/helm-charts/getting-started-scalardb/ - - title: "Configure a custom values file for Scalar Helm Charts" + - title: "Configure a Custom Values File for Scalar Helm Charts" url: /docs/3.8/helm-charts/configure-custom-values-file/ - - title: "Deploy Scalar products using Scalar Helm Charts" + - title: "Deploy Scalar Products Using Scalar Helm Charts" url: /docs/3.8/helm-charts/how-to-deploy-scalar-products/ - - title: "Mount any files or volumes on Scalar product pods" + - title: "Mount Any Files or Volumes on Scalar Product Pods" url: /docs/3.8/helm-charts/mount-files-or-volumes-on-scalar-pods/ - - title: "How to use Secret resources to pass the credentials as the environment variables into the properties file" + - title: "How to Use Secret Resources to Pass Credentials as Environment Variables into the Properties File" url: /docs/3.8/helm-charts/use-secret-for-credentials/ - title: "ScalarDB GraphQL Deployment Guide on AWS" url: /docs/3.8/scalardb-graphql/aws-deployment-guide/ @@ -423,7 +431,7 @@ versions: # Manage docs - title: "Manage" children: - - title: "How to Backup and Restore Databases Used Through ScalarDB" + - title: "How to Back Up and Restore Databases Used Through ScalarDB" url: /docs/3.8/backup-restore/ - title: "Managing ScalarDB on Managed Kubernetes Services" url: /docs/3.8/scalar-kubernetes/manage-kubernetes/ @@ -439,9 +447,9 @@ versions: url: /docs/3.8/design/ - title: "ScalarDB Supported Databases" url: /docs/3.8/scalardb-supported-databases/ - - title: "Requirements in the Underlying Databases of ScalarDB" + - title: "Requirements and Recommendations for the Underlying Databases of ScalarDB" url: /docs/3.8/requirements/ - - title: "Storage Abstraction" + - title: "Storage Abstraction and API Guide" url: /docs/3.8/storage-abstraction/ - title: "ScalarDB Benchmarks" url: /docs/3.8/scalardb-benchmarks/README/ @@ -519,17 +527,19 @@ versions: # Develop docs - title: "Develop" children: - - title: "Add ScalarDB to your build" + - title: "Add ScalarDB to Your Build" url: /docs/3.7/add-scalardb-to-your-build/ - title: "Developer Guides for ScalarDB" url: /docs/3.7/guides/ - title: "Configuration Guides for ScalarDB" url: /docs/3.7/development-configurations/ + - title: "ScalarDB Schema Loader" + url: /docs/3.7/schema-loader/ - title: "Export Function for ScalarDB Data Loader" url: /docs/3.7/scalardb-data-loader/getting-started-export/ - title: "Import Function for ScalarDB Data Loader" url: /docs/3.7/scalardb-data-loader/getting-started-import/ - - title: "How to Run Two-Phase Commit Transaction" + - title: "How to Run Two-Phase Commit Transaction by Using ScalarDB GraphQL" url: /docs/3.7/scalardb-graphql/how-to-run-two-phase-commit-transaction/ - title: "How to Run ScalarDB GraphQL Server" url: /docs/3.7/scalardb-graphql/how-to-run-server/ @@ -548,13 +558,13 @@ versions: url: /docs/3.7/scalardb-server/ - title: "Getting Started with Helm Charts (ScalarDB Server)" url: /docs/3.7/helm-charts/getting-started-scalardb/ - - title: "Configure a custom values file for Scalar Helm Charts" + - title: "Configure a Custom Values File for Scalar Helm Charts" url: /docs/3.7/helm-charts/configure-custom-values-file/ - - title: "Deploy Scalar products using Scalar Helm Charts" + - title: "Deploy Scalar Products Using Scalar Helm Charts" url: /docs/3.7/helm-charts/how-to-deploy-scalar-products/ - - title: "Mount any files or volumes on Scalar product pods" + - title: "Mount Any Files or Volumes on Scalar Product Pods" url: /docs/3.7/helm-charts/mount-files-or-volumes-on-scalar-pods/ - - title: "How to use Secret resources to pass the credentials as the environment variables into the properties file" + - title: "How to Use Secret Resources to Pass Credentials as Environment Variables into the Properties File" url: /docs/3.7/helm-charts/use-secret-for-credentials/ - title: "ScalarDB GraphQL Deployment Guide on AWS" url: /docs/3.7/scalardb-graphql/aws-deployment-guide/ @@ -563,7 +573,7 @@ versions: # Manage docs - title: "Manage" children: - - title: "How to Backup and Restore Databases Used Through ScalarDB" + - title: "How to Back Up and Restore Databases Used Through ScalarDB" url: /docs/3.7/backup-restore/ - title: "Managing ScalarDB on Managed Kubernetes Services" url: /docs/3.7/scalar-kubernetes/manage-kubernetes/ @@ -579,9 +589,9 @@ versions: url: /docs/3.7/design/ - title: "ScalarDB Supported Databases" url: /docs/3.7/scalardb-supported-databases/ - - title: "Requirements in the Underlying Databases of ScalarDB" + - title: "Requirements and Recommendations for the Underlying Databases of ScalarDB" url: /docs/3.7/requirements/ - - title: "Storage Abstraction" + - title: "Storage Abstraction and API Guide" url: /docs/3.7/storage-abstraction/ - title: "ScalarDB Benchmarks" url: /docs/3.7/scalardb-benchmarks/README/ @@ -659,17 +669,19 @@ versions: # Develop docs - title: "Develop" children: - - title: "Add ScalarDB to your build" + - title: "Add ScalarDB to Your Build" url: /docs/3.6/add-scalardb-to-your-build/ - title: "Developer Guides for ScalarDB" url: /docs/3.6/guides/ - title: "Configuration Guides for ScalarDB" url: /docs/3.6/development-configurations/ + - title: "ScalarDB Schema Loader" + url: /docs/3.6/schema-loader/ - title: "Export Function for ScalarDB Data Loader" url: /docs/3.6/scalardb-data-loader/getting-started-export/ - title: "Import Function for ScalarDB Data Loader" url: /docs/3.6/scalardb-data-loader/getting-started-import/ - - title: "How to Run Two-Phase Commit Transaction" + - title: "How to Run Two-Phase Commit Transaction by Using ScalarDB GraphQL" url: /docs/3.6/scalardb-graphql/how-to-run-two-phase-commit-transaction/ - title: "How to Run ScalarDB GraphQL Server" url: /docs/3.6/scalardb-graphql/how-to-run-server/ @@ -688,13 +700,13 @@ versions: url: /docs/3.6/scalardb-server/ - title: "Getting Started with Helm Charts (ScalarDB Server)" url: /docs/3.6/helm-charts/getting-started-scalardb/ - - title: "Configure a custom values file for Scalar Helm Charts" + - title: "Configure a Custom Values File for Scalar Helm Charts" url: /docs/3.6/helm-charts/configure-custom-values-file/ - - title: "Deploy Scalar products using Scalar Helm Charts" + - title: "Deploy Scalar Products Using Scalar Helm Charts" url: /docs/3.6/helm-charts/how-to-deploy-scalar-products/ - - title: "Mount any files or volumes on Scalar product pods" + - title: "Mount Any Files or Volumes on Scalar Product Pods" url: /docs/3.6/helm-charts/mount-files-or-volumes-on-scalar-pods/ - - title: "How to use Secret resources to pass the credentials as the environment variables into the properties file" + - title: "How to Use Secret Resources to Pass Credentials as Environment Variables into the Properties File" url: /docs/3.6/helm-charts/use-secret-for-credentials/ - title: "ScalarDB GraphQL Deployment Guide on AWS" url: /docs/3.6/scalardb-graphql/aws-deployment-guide/ @@ -703,7 +715,7 @@ versions: # Manage docs - title: "Manage" children: - - title: "How to Backup and Restore Databases Used Through ScalarDB" + - title: "How to Back Up and Restore Databases Used Through ScalarDB" url: /docs/3.6/backup-restore/ - title: "Managing ScalarDB on Managed Kubernetes Services" url: /docs/3.6/scalar-kubernetes/manage-kubernetes/ @@ -719,9 +731,9 @@ versions: url: /docs/3.6/design/ - title: "ScalarDB Supported Databases" url: /docs/3.6/scalardb-supported-databases/ - - title: "Requirements in the Underlying Databases of ScalarDB" + - title: "Requirements and Recommendations for the Underlying Databases of ScalarDB" url: /docs/3.6/requirements/ - - title: "Storage Abstraction" + - title: "Storage Abstraction and API Guide" url: /docs/3.6/storage-abstraction/ - title: "ScalarDB Benchmarks" url: /docs/3.6/scalardb-benchmarks/README/ @@ -795,10 +807,12 @@ versions: # Develop docs - title: "Develop" children: - - title: "Add ScalarDB to your build" + - title: "Add ScalarDB to Your Build" url: /docs/3.5/add-scalardb-to-your-build/ - title: "Configuration Guides for ScalarDB" url: /docs/3.5/development-configurations/ + - title: "ScalarDB Schema Loader" + url: /docs/3.5/schema-loader/ - title: "Export Function for ScalarDB Data Loader" url: /docs/3.5/scalardb-data-loader/getting-started-export/ - title: "Import Function for ScalarDB Data Loader" @@ -807,7 +821,7 @@ versions: url: /docs/3.5/multi-storage-transactions/ - title: "Two-Phase Commit Transactions" url: /docs/3.5/two-phase-commit-transactions/ - - title: "How to Run Two-Phase Commit Transaction" + - title: "How to Run Two-Phase Commit Transaction by Using ScalarDB GraphQL" url: /docs/3.5/scalardb-graphql/how-to-run-two-phase-commit-transaction/ - title: "How to Run ScalarDB GraphQL Server" url: /docs/3.5/scalardb-graphql/how-to-run-server/ @@ -824,20 +838,20 @@ versions: url: /docs/3.5/scalardb-server/ - title: "Getting Started with Helm Charts (ScalarDB Server)" url: /docs/3.5/helm-charts/getting-started-scalardb/ - - title: "Configure a custom values file for Scalar Helm Charts" + - title: "Configure a Custom Values File for Scalar Helm Charts" url: /docs/3.5/helm-charts/configure-custom-values-file/ - - title: "Deploy Scalar products using Scalar Helm Charts" + - title: "Deploy Scalar Products Using Scalar Helm Charts" url: /docs/3.5/helm-charts/how-to-deploy-scalar-products/ - - title: "Mount any files or volumes on Scalar product pods" + - title: "Mount Any Files or Volumes on Scalar Product Pods" url: /docs/3.5/helm-charts/mount-files-or-volumes-on-scalar-pods/ - - title: "How to use Secret resources to pass the credentials as the environment variables into the properties file" + - title: "How to Use Secret Resources to Pass Credentials as Environment Variables into the Properties File" url: /docs/3.5/helm-charts/use-secret-for-credentials/ - title: "ScalarDB GraphQL Deployment Guide on AWS" url: /docs/3.5/scalardb-graphql/aws-deployment-guide/ # Manage docs - title: "Manage" children: - - title: "How to Backup and Restore Databases Used Through ScalarDB" + - title: "How to Back Up and Restore Databases Used Through ScalarDB" url: /docs/3.5/backup-restore/ - title: "Managing ScalarDB on Managed Kubernetes Services" url: /docs/3.5/scalar-kubernetes/manage-kubernetes/ @@ -853,7 +867,7 @@ versions: url: /docs/3.5/design/ - title: "ScalarDB Supported Databases" url: /docs/3.5/scalardb-supported-databases/ - - title: "Requirements in the Underlying Databases of ScalarDB" + - title: "Requirements and Recommendations for the Underlying Databases of ScalarDB" url: /docs/3.5/requirements/ - title: "ScalarDB Benchmarks" url: /docs/3.5/scalardb-benchmarks/README/ @@ -921,7 +935,7 @@ versions: # Develop docs - title: "Develop" children: - - title: "Add ScalarDB to your build" + - title: "Add ScalarDB to Your Build" url: /docs/3.4/add-scalardb-to-your-build/ - title: "Configuration Guides for ScalarDB" url: /docs/3.4/development-configurations/ @@ -942,18 +956,18 @@ versions: url: /docs/3.4/scalardb-server/ - title: "Getting Started with Helm Charts (ScalarDB Server)" url: /docs/3.4/helm-charts/getting-started-scalardb/ - - title: "Configure a custom values file for Scalar Helm Charts" + - title: "Configure a Custom Values File for Scalar Helm Charts" url: /docs/3.4/helm-charts/configure-custom-values-file/ - - title: "Deploy Scalar products using Scalar Helm Charts" + - title: "Deploy Scalar Products Using Scalar Helm Charts" url: /docs/3.4/helm-charts/how-to-deploy-scalar-products/ - - title: "Mount any files or volumes on Scalar product pods" + - title: "Mount Any Files or Volumes on Scalar Product Pods" url: /docs/3.4/helm-charts/mount-files-or-volumes-on-scalar-pods/ - - title: "How to use Secret resources to pass the credentials as the environment variables into the properties file" + - title: "How to Use Secret Resources to Pass Credentials as Environment Variables into the Properties File" url: /docs/3.4/helm-charts/use-secret-for-credentials/ # Manage docs - title: "Manage" children: - - title: "How to Backup and Restore Databases Used Through ScalarDB" + - title: "How to Back Up and Restore Databases Used Through ScalarDB" url: /docs/3.4/backup-restore/ - title: "Managing ScalarDB on Managed Kubernetes Services" url: /docs/3.4/scalar-kubernetes/manage-kubernetes/ @@ -969,7 +983,7 @@ versions: url: /docs/3.4/design/ - title: "ScalarDB Supported Databases" url: /docs/3.4/scalardb-supported-databases/ - - title: "Requirements in the Underlying Databases of ScalarDB" + - title: "Requirements and Recommendations for the Underlying Databases of ScalarDB" url: /docs/3.4/requirements/ - title: "ScalarDB Benchmarks" url: /docs/3.4/scalardb-benchmarks/README/