Merge pull request #139 from scalar-labs/add-docs-for-3.12

Add docs for ScalarDB 3.12

_config.yml

@@ -195,6 +195,19 @@ defaults:
       toc: true
       toc_sticky: true
       search: true
+  # 3.12
+  - scope:
+      path: "docs/3.12" # Specifies the name of the folder where this version of docs are located.
+      # type: "" # Since this scope uses `collection_dir`, we do not need to specify the type here.
+    values:
+      layout: page # Specifies the type of template used from the "_layouts" folder.
+      read_time: false # Shows the average reading time for pages.
+      share: false # Shows social media buttons to share pages.
+      sidebar: # Shows side navigation content from `_data/navigation.yml`.
+        nav: "latest" # Add the version enclosed within quotation marks. If the docs in the navigation is for the latest version of the product, be sure to set `nav:` to `"latest"`. If the docs in the navigation is for a previous version of the product, be sure to set `nav:` to the product version number (e.g., `"3.8"`). That version number must match the set of docs for that product version in `_data/navigation.yml`.
+      toc: true
+      toc_sticky: true
+      search: false
   # 3.11
   - scope:
       path: "docs/3.11" # Specifies the name of the folder where this version of docs are located.
@@ -204,7 +217,7 @@ defaults:
       read_time: false # Shows the average reading time for pages.
       share: false # Shows social media buttons to share pages.
       sidebar: # Shows side navigation content from `_data/navigation.yml`.
-        nav: "latest" # Add the version enclosed within quotation marks. If the docs in the navigation is for the latest version of the product, be sure to set `nav:` to `"latest"`. If the docs in the navigation is for a previous version of the product, be sure to set `nav:` to the product version number (e.g., `"3.8"`). That version number must match the set of docs for that product version in `_data/navigation.yml`.
+        nav: "3.11" # Add the version enclosed within quotation marks. If the docs in the navigation is for the latest version of the product, be sure to set `nav:` to `"latest"`. If the docs in the navigation is for a previous version of the product, be sure to set `nav:` to the product version number (e.g., `"3.8"`). That version number must match the set of docs for that product version in `_data/navigation.yml`.
       toc: true
       toc_sticky: true
       search: false

_data/navigation.yml

@@ -37,8 +37,10 @@ editions:
 versions:
   - version-top-title: "" # This title is taken from the `version_label` in `_data/ui-text.yml`.
     version-children:
-    - version-title: "3.11 (latest)"
+    - version-title: "3.12 (latest)"
       version-url: /docs/latest/getting-started-with-scalardb/
+    - version-title: "3.11"
+      version-url: /docs/3.11/getting-started-with-scalardb/
     - version-title: "3.10"
       version-url: /docs/3.10/getting-started-with-scalardb/
     - version-title: "3.9"
@@ -62,9 +64,9 @@ versions:
 # After that, add a new scope in `_config.yml` to include an item that provides the proper versioned navigation to the site when someone visits the page (i.e., make sure people who visit a version 3.8 doc are shown a side navigation that includes only 3.8 docs.)
 
 "latest":
-  - title: "⬅ ScalarDB Enterprise docs home" 
+  - title: "⬅ ScalarDB Enterprise docs home"
     url: /docs/ # Don't change this URL. This links back to the parent product home page.
-  - title: "ScalarDB 3.11 Enterprise"
+  - title: "ScalarDB 3.12 Enterprise"
     children:
   # Get Started docs
   - title: "Get Started"
@@ -88,9 +90,9 @@ versions:
       - title: "Getting Started with the ScalarDB Cluster .NET Client SDK"
         url: /docs/latest/scalardb-cluster-dotnet-client-sdk/
   # Samples docs
-  - title: "Samples" 
+  - title: "Samples"
     children:
-      - title: "ScalarDB Samples" 
+      - title: "ScalarDB Samples"
         url: /docs/latest/scalardb-samples/README/
       # - title: "ScalarDB Samples"
       #   url: /docs/latest/scalardb-samples/scalardb-sample/README/
@@ -171,7 +173,7 @@ versions:
   # - title: "Migrate"
   #   children:
   #     - title: ""
-  #       url: 
+  #       url:
   # Reference docs
   - title: "Reference"
     children:
@@ -211,8 +213,158 @@ versions:
       - title: "Release Support Policy"
         url: /docs/releases/release-support-policy/
 
+"3.11":
+  - title: "⬅ ScalarDB Enterprise docs home"
+    url: /docs/ # Don't change this URL. This links back to the parent product home page.
+  - title: "ScalarDB 3.11 Enterprise"
+    children:
+  # Get Started docs
+  - title: "Get Started"
+    children:
+      # - title: "Getting Started with ScalarDB on Cassandra"
+      #   url: /docs/3.11/getting-started-with-scalardb-on-cassandra/
+      # - title: "Getting Started with ScalarDB on Cosmos DB"
+      #   url: /docs/3.11/getting-started-with-scalardb-on-cosmosdb/
+      # - title: "Getting Started with ScalarDB on DynamoDB"
+      #   url: /docs/3.11/getting-started-with-scalardb-on-dynamodb/
+      # - title: "Getting Started with ScalarDB on JDBC databases"
+      #   url: /docs/3.11/getting-started-with-scalardb-on-jdbc/
+      - title: "Getting Started with ScalarDB"
+        url: /docs/3.11/getting-started-with-scalardb/
+      - title: "Getting Started with ScalarDB by Using Kotlin"
+        url: /docs/3.11/getting-started-with-scalardb-by-using-kotlin/
+      - title: "Getting Started with ScalarDB Analytics with PostgreSQL"
+        url: /docs/3.11/scalardb-analytics-postgresql/getting-started/
+      - title: "Getting Started with ScalarDB Cluster"
+        url: /docs/3.11/scalardb-cluster/getting-started-with-scalardb-cluster-overview/
+      - title: "Getting Started with the ScalarDB Cluster .NET Client SDK"
+        url: /docs/3.11/scalardb-cluster-dotnet-client-sdk/
+  # Samples docs
+  - title: "Samples"
+    children:
+      - title: "ScalarDB Samples"
+        url: /docs/3.11/scalardb-samples/README/
+      # - title: "ScalarDB Samples"
+      #   url: /docs/3.11/scalardb-samples/scalardb-sample/README/
+      # - title: "Microservice Transaction Sample"
+      #   url: /docs/3.11/scalardb-samples/microservice-transaction-sample/README/
+      # - title: "Multi-Storage Transaction Sample"
+      #   url: /docs/3.11/scalardb-samples/multi-storage-transaction-sample/README/
+      # - title: "ScalarDB GraphQL Sample"
+      #   url: /docs/3.11/scalardb-samples/scalardb-graphql-sample/README/
+      # - title: "Spring Data Multi-Storage Transaction Sample"
+      #   url: /docs/3.11/scalardb-samples/spring-data-multi-storage-transaction-sample/README/
+      # - title: "Spring Data Sample"
+      #   url: /docs/3.11/scalardb-samples/spring-data-sample/README/
+  # Develop docs
+  - title: "Develop"
+    children:
+      - title: "Add ScalarDB to Your Build"
+        url: /docs/3.11/add-scalardb-to-your-build/
+      - title: "Add ScalarDB SQL to Your Build"
+        url: /docs/3.11/scalardb-sql/add-scalardb-sql-to-your-build/
+      - title: "Developer Guides for ScalarDB"
+        url: /docs/3.11/guides/
+      - title: "Configuration Guides for ScalarDB"
+        url: /docs/3.11/development-configurations/
+      - title: "ScalarDB Schema Loader"
+        url: /docs/3.11/schema-loader/
+      - title: "Importing Existing Tables to ScalarDB by Using ScalarDB Schema Loader"
+        url: /docs/3.11/schema-loader-import/
+      - title: "ScalarDB FDW for ScalarDB Analytics with PostgreSQL"
+        url: /docs/3.11/scalardb-analytics-postgresql/scalardb-fdw/
+      - title: "Schema Importer for ScalarDB Analytics with PostgreSQL"
+        url: /docs/3.11/scalardb-analytics-postgresql/schema-importer/
+      # - title: "Export Function for ScalarDB Data Loader" # May be added in the near future.
+      #   url: /docs/3.11/scalardb-data-loader/getting-started-export/
+      # - title: "Import Function for ScalarDB Data Loader" # May be added in the near future.
+      #   url: /docs/3.11/scalardb-data-loader/getting-started-import/
+      - title: "ScalarDB Auth with ScalarDB SQL"
+        url : /docs/3.11/scalardb-cluster/scalardb-auth-with-sql/
+      - title: "How to Run ScalarDB GraphQL Server"
+        url: /docs/3.11/scalardb-graphql/how-to-run-server/
+      - title: "How to Run Two-Phase Commit Transaction by Using ScalarDB GraphQL"
+        url: /docs/3.11/scalardb-graphql/how-to-run-two-phase-commit-transaction/
+      - title: "ScalarDB SQL Command Line Interface"
+        url: /docs/3.11/scalardb-sql/command-line-interface/
+  # Deploy docs
+  - title: "Deploy"
+    children:
+      - title: "Deploying ScalarDB on Managed Kubernetes Services"
+        url: /docs/3.11/scalar-kubernetes/deploy-kubernetes/
+      - title: "Getting Started with Scalar Helm Charts"
+        url: /docs/3.11/helm-charts/getting-started-scalar-helm-charts/
+      - title: "Set Up ScalarDB Cluster on Kubernetes by Using a Helm Chart"
+        url: /docs/3.11/scalardb-cluster/setup-scalardb-cluster-on-kubernetes-by-using-helm-chart/
+      - title: "Configure a Custom Values File for Scalar Helm Charts"
+        url: /docs/3.11/helm-charts/configure-custom-values-file/
+      - title: "Deploy Scalar Products Using Scalar Helm Charts"
+        url: /docs/3.11/helm-charts/how-to-deploy-scalar-products/
+      - title: "Mount Any Files or Volumes on Scalar Product Pods"
+        url: /docs/3.11/helm-charts/mount-files-or-volumes-on-scalar-pods/
+      - title: "How to Use Secret Resources to Pass Credentials as Environment Variables into the Properties File"
+        url: /docs/3.11/helm-charts/use-secret-for-credentials/
+      - title: "How to Install ScalarDB Analytics with PostgreSQL in Your Local Environment by Using Docker"
+        url: /docs/3.11/scalardb-analytics-postgresql/installation/
+      - title: "ScalarDB Cluster Standalone Mode"
+        url: /docs/3.11/scalardb-cluster/standalone-mode/
+      - title: "ScalarDB GraphQL Deployment Guide on AWS"
+        url: /docs/3.11/scalardb-graphql/aws-deployment-guide/
+      - title: "ScalarDB SQL Server"
+        url: /docs/3.11/scalardb-sql/sql-server/
+  # Manage docs
+  - title: "Manage"
+    children:
+      - title: "How to Back Up and Restore Databases Used Through ScalarDB"
+        url: /docs/3.11/backup-restore/
+      - title: "Managing ScalarDB on Managed Kubernetes Services"
+        url: /docs/3.11/scalar-kubernetes/manage-kubernetes/
+  # Migrate docs
+  # - title: "Migrate"
+  #   children:
+  #     - title: ""
+  #       url: 
+  # Reference docs
+  - title: "Reference"
+    children:
+      - title: "ScalarDB Design Document"
+        url: /docs/3.11/design/
+      - title: "ScalarDB Supported Databases"
+        url: /docs/3.11/scalardb-supported-databases/
+      - title: "Requirements and Recommendations for the Underlying Databases of ScalarDB"
+        url: /docs/3.11/requirements/
+      - title: "Storage Abstraction and API Guide"
+        url: /docs/3.11/storage-abstraction/
+      - title: "ScalarDB Benchmarks"
+        url: /docs/3.11/scalardb-benchmarks/README/
+      - title: "ScalarDB Cluster"
+        url: /docs/3.11/scalardb-cluster/
+      - title: "ScalarDB SQL Grammar"
+        url: /docs/3.11/scalardb-sql/grammar/
+  # Release docs and notes
+  - title: "Releases"
+    children:
+      - title: "Release Notes"
+        url: /docs/releases/
+      # - title: "v3.10"
+      #   url: /docs/releases/release-3.10/
+      # - title: "v3.9"
+      #   url: /docs/releases/release-3.9/
+      # - title: "v3.8"
+      #   url: /docs/releases/release-3.8/
+      # - title: "v3.7"
+      #   url: /docs/releases/release-3.7/
+      # - title: "v3.6"
+      #   url: /docs/releases/release-3.6/
+      # - title: "v3.5"
+      #   url: /docs/releases/release-3.5/
+      # - title: "v3.4"
+      #   url: /docs/releases/release-3.4/
+      - title: "Release Support Policy"
+        url: /docs/releases/release-support-policy/
+
 "3.10":
-  - title: "⬅ ScalarDB Enterprise docs home" 
+  - title: "⬅ ScalarDB Enterprise docs home"
     url: /docs/ # Don't change this URL. This links back to the parent product home page.
   - title: "ScalarDB 3.10 Enterprise"
     children:
@@ -236,9 +388,9 @@ versions:
       - title: "Getting Started with ScalarDB Cluster"
         url: /docs/3.10/scalardb-cluster/getting-started-with-scalardb-cluster-overview/
   # Samples docs
-  - title: "Samples" 
+  - title: "Samples"
     children:
-      - title: "ScalarDB Samples" 
+      - title: "ScalarDB Samples"
         url: /docs/3.10/scalardb-samples/README/
       # - title: "ScalarDB Samples"
       #   url: /docs/3.10/scalardb-samples/scalardb-sample/README/
@@ -354,7 +506,7 @@ versions:
         url: /docs/releases/release-support-policy/
 
 "3.9":
-  - title: "⬅ ScalarDB Enterprise docs home" 
+  - title: "⬅ ScalarDB Enterprise docs home"
     url: /docs/ # Don't change this URL. This links back to the parent product home page.
   - title: "ScalarDB 3.9 Enterprise"
     children:
@@ -378,9 +530,9 @@ versions:
       - title: "Getting Started with ScalarDB Cluster"
         url: /docs/3.9/scalardb-cluster/getting-started-with-scalardb-cluster-overview/
   # Samples docs
-  - title: "Samples" 
+  - title: "Samples"
     children:
-      - title: "ScalarDB Samples" 
+      - title: "ScalarDB Samples"
         url: /docs/3.9/scalardb-samples/README/
       # - title: "ScalarDB Samples"
       #   url: /docs/3.9/scalardb-samples/scalardb-sample/README/
@@ -496,7 +648,7 @@ versions:
         url: /docs/releases/release-support-policy/
 
 "3.8":
-  - title: "⬅ ScalarDB Enterprise docs home" 
+  - title: "⬅ ScalarDB Enterprise docs home"
     url: /docs/ # Don't change this URL. This links back to the parent product home page.
   - title: "ScalarDB 3.8 Enterprise"
     children:
@@ -522,9 +674,9 @@ versions:
       - title: "Getting Started with ScalarDB SQL"
         url: /docs/3.8/scalardb-sql/getting-started-with-sql/
   # Samples docs
-  - title: "Samples" 
+  - title: "Samples"
     children:
-      - title: "ScalarDB Samples" 
+      - title: "ScalarDB Samples"
         url: /docs/3.8/scalardb-samples/README/
       # - title: "ScalarDB Samples"
       #   url: /docs/3.8/scalardb-samples/scalardb-sample/README/
@@ -638,7 +790,7 @@ versions:
         url: /docs/releases/release-support-policy/
 
 "3.7":
-  - title: "⬅ ScalarDB Enterprise docs home" 
+  - title: "⬅ ScalarDB Enterprise docs home"
     url: /docs/ # Don't change this URL. This links back to the parent product home page.
   - title: "ScalarDB 3.7 Enterprise"
     children:
@@ -664,9 +816,9 @@ versions:
       - title: "Getting Started with ScalarDB SQL"
         url: /docs/3.7/scalardb-sql/getting-started-with-sql/
   # Samples docs
-  - title: "Samples" 
+  - title: "Samples"
     children:
-      - title: "ScalarDB Samples" 
+      - title: "ScalarDB Samples"
         url: /docs/3.7/scalardb-samples/README/
       # - title: "ScalarDB Samples"
       #   url: /docs/3.7/scalardb-samples/scalardb-sample/README/
@@ -778,7 +930,7 @@ versions:
         url: /docs/releases/release-support-policy/
 
 "3.6":
-  - title: "⬅ ScalarDB Enterprise docs home" 
+  - title: "⬅ ScalarDB Enterprise docs home"
     url: /docs/ # Don't change this URL. This links back to the parent product home page.
   - title: "ScalarDB 3.6 Enterprise"
     children:
@@ -804,9 +956,9 @@ versions:
       - title: "Getting Started with ScalarDB SQL"
         url: /docs/3.6/scalardb-sql/getting-started-with-sql/
   # Samples docs
-  - title: "Samples" 
+  - title: "Samples"
     children:
-      - title: "ScalarDB Samples" 
+      - title: "ScalarDB Samples"
         url: /docs/3.6/scalardb-samples/README/
       # - title: "ScalarDB Samples"
       #   url: /docs/3.6/scalardb-samples/scalardb-sample/README/
@@ -918,7 +1070,7 @@ versions:
         url: /docs/releases/release-support-policy/
 
 "3.5":
-  - title: "⬅ ScalarDB Enterprise docs home" 
+  - title: "⬅ ScalarDB Enterprise docs home"
     url: /docs/ # Don't change this URL. This links back to the parent product home page.
   - title: "ScalarDB 3.5 Enterprise"
     children:
@@ -940,9 +1092,9 @@ versions:
       - title: "Getting Started with ScalarDB GraphQL"
         url: /docs/3.5/scalardb-graphql/getting-started-with-scalardb-graphql/
   # Samples docs
-  - title: "Samples" 
+  - title: "Samples"
     children:
-      - title: "ScalarDB Samples" 
+      - title: "ScalarDB Samples"
         url: /docs/3.5/scalardb-samples/README/
       # - title: "ScalarDB Samples"
       #   url: /docs/3.5/scalardb-samples/scalardb-sample/README/
@@ -1048,7 +1200,7 @@ versions:
         url: /docs/releases/release-support-policy/
 
 "3.4":
-  - title: "⬅ ScalarDB Enterprise docs home" 
+  - title: "⬅ ScalarDB Enterprise docs home"
     url: /docs/ # Don't change this URL. This links back to the parent product home page.
   - title: "ScalarDB 3.4 Enterprise"
     children:
@@ -1068,9 +1220,9 @@ versions:
       - title: "Getting Started with ScalarDB"
         url: /docs/3.4/getting-started-with-scalardb/
   # Samples docs
-  - title: "Samples" 
+  - title: "Samples"
     children:
-      - title: "ScalarDB Samples" 
+      - title: "ScalarDB Samples"
         url: /docs/3.4/scalardb-samples/README/
       # - title: "ScalarDB Samples"
       #   url: /docs/3.4/scalardb-samples/scalardb-sample/README/