Merge pull request #110 from scalar-labs/add-3.11-docs

Add docs for ScalarDB 3.11

_config.yml

@@ -194,6 +194,19 @@ defaults:
       toc: true
       toc_sticky: true
       search: true
+  # 3.11
+  - scope:
+      path: "docs/3.11" # 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.10
   - scope:
       path: "docs/3.10" # Specifies the name of the folder where this version of docs are located.
@@ -203,7 +216,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.10" # 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.10 (latest)"
+    - version-title: "3.11 (latest)"
       version-url: /docs/latest/getting-started-with-scalardb/
+    - version-title: "3.10"
+      version-url: /docs/3.10/getting-started-with-scalardb/
     - version-title: "3.9"
       version-url: /docs/3.9/getting-started-with-scalardb/
     - version-title: "3.8"
@@ -63,7 +65,7 @@ versions:
 "latest":
   - 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"
+  - title: "ScalarDB 3.11 Enterprise"
     children:
   # Get Started docs
   - title: "Get Started"
@@ -114,6 +116,8 @@ versions:
         url: /docs/latest/development-configurations/
       - title: "ScalarDB Schema Loader"
         url: /docs/latest/schema-loader/
+      - title: "Importing Existing Tables to ScalarDB by Using ScalarDB Schema Loader"
+        url: /docs/latest/schema-loader-import/
       - title: "ScalarDB FDW"
         url: /docs/latest/scalardb-analytics-postgresql/scalardb-fdw/
       - title: "Schema Importer"
@@ -202,6 +206,148 @@ versions:
       # - title: "Release Support Policy"
       #   url: /docs/releases/release-support-policy
 
+"3.10":
+  - 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:
+  # Get Started docs
+  - title: "Get Started"
+    children:
+      # - title: "Getting Started with ScalarDB on Cassandra"
+      #   url: /docs/3.10/getting-started-with-scalardb-on-cassandra/
+      # - title: "Getting Started with ScalarDB on Cosmos DB"
+      #   url: /docs/3.10/getting-started-with-scalardb-on-cosmosdb/
+      # - title: "Getting Started with ScalarDB on DynamoDB"
+      #   url: /docs/3.10/getting-started-with-scalardb-on-dynamodb/
+      # - title: "Getting Started with ScalarDB on JDBC databases"
+      #   url: /docs/3.10/getting-started-with-scalardb-on-jdbc/
+      - title: "Getting Started with ScalarDB"
+        url: /docs/3.10/getting-started-with-scalardb/
+      - title: "Getting Started with ScalarDB by Using Kotlin"
+        url: /docs/3.10/getting-started-with-scalardb-by-using-kotlin/
+      - title: "Getting Started with ScalarDB Cluster"
+        url: /docs/3.10/scalardb-cluster/getting-started-with-scalardb-cluster-overview/
+      - title: "Getting Started with ScalarDB Analytics with PostgreSQL"
+        url: /docs/3.10/scalardb-analytics-postgresql/getting-started/
+  # Samples docs
+  - title: "Samples" 
+    children:
+      - title: "ScalarDB Samples" 
+        url: /docs/3.10/scalardb-samples/README/
+      # - title: "ScalarDB Samples"
+      #   url: /docs/3.10/scalardb-samples/scalardb-sample/README/
+      # - title: "Microservice Transaction Sample"
+      #   url: /docs/3.10/scalardb-samples/microservice-transaction-sample/README/
+      # - title: "Multi-Storage Transaction Sample"
+      #   url: /docs/3.10/scalardb-samples/multi-storage-transaction-sample/README/
+      # - title: "ScalarDB GraphQL Sample"
+      #   url: /docs/3.10/scalardb-samples/scalardb-graphql-sample/README/
+      # - title: "Spring Data Multi-Storage Transaction Sample"
+      #   url: /docs/3.10/scalardb-samples/spring-data-multi-storage-transaction-sample/README/
+      # - title: "Spring Data Sample"
+      #   url: /docs/3.10/scalardb-samples/spring-data-sample/README/
+  # Develop docs
+  - title: "Develop"
+    children:
+      - title: "Add ScalarDB to Your Build"
+        url: /docs/3.10/add-scalardb-to-your-build/
+      - title: "Add ScalarDB SQL to Your Build"
+        url: /docs/3.10/scalardb-sql/add-scalardb-sql-to-your-build/
+      - title: "Developer Guides for ScalarDB"
+        url: /docs/3.10/guides/
+      - title: "Configuration Guides for ScalarDB"
+        url: /docs/3.10/development-configurations/
+      - title: "ScalarDB Schema Loader"
+        url: /docs/3.10/schema-loader/
+      - title: "ScalarDB FDW"
+        url: /docs/3.10/scalardb-analytics-postgresql/scalardb-fdw/
+      - title: "Schema Importer"
+        url: /docs/3.10/scalardb-analytics-postgresql/schema-importer/
+      # - title: "Export Function for ScalarDB Data Loader" # May be added in the near future.
+      #   url: /docs/3.10/scalardb-data-loader/getting-started-export/
+      # - title: "Import Function for ScalarDB Data Loader" # May be added in the near future.
+      #   url: /docs/3.10/scalardb-data-loader/getting-started-import/
+      - title: "How to Run ScalarDB GraphQL Server"
+        url: /docs/3.10/scalardb-graphql/how-to-run-server/
+      - title: "How to Run Two-Phase Commit Transaction by Using ScalarDB GraphQL"
+        url: /docs/3.10/scalardb-graphql/how-to-run-two-phase-commit-transaction/
+      - title: "ScalarDB SQL Command Line Interface"
+        url: /docs/3.10/scalardb-sql/command-line-interface/
+  # Deploy docs
+  - title: "Deploy"
+    children:
+      - title: "Deploying ScalarDB on Managed Kubernetes Services"
+        url: /docs/3.10/scalar-kubernetes/deploy-kubernetes/
+      - title: "Getting Started with Scalar Helm Charts"
+        url: /docs/3.10/helm-charts/getting-started-scalar-helm-charts/
+      - title: "Set Up ScalarDB Cluster on Kubernetes by Using a Helm Chart"
+        url: /docs/3.10/scalardb-cluster/setup-scalardb-cluster-on-kubernetes-by-using-helm-chart/
+      - title: "Configure a Custom Values File for Scalar Helm Charts"
+        url: /docs/3.10/helm-charts/configure-custom-values-file/
+      - title: "Deploy Scalar Products Using Scalar Helm Charts"
+        url: /docs/3.10/helm-charts/how-to-deploy-scalar-products/
+      - title: "Mount Any Files or Volumes on Scalar Product Pods"
+        url: /docs/3.10/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.10/helm-charts/use-secret-for-credentials/
+      - title: "How to Install ScalarDB Analytics with PostgreSQL in Your Local Environment by Using Docker"
+        url: /docs/3.10/scalardb-analytics-postgresql/installation/
+      - title: "ScalarDB GraphQL Deployment Guide on AWS"
+        url: /docs/3.10/scalardb-graphql/aws-deployment-guide/
+      - title: "ScalarDB SQL Server"
+        url: /docs/3.10/scalardb-sql/sql-server/
+  # Manage docs
+  - title: "Manage"
+    children:
+      - title: "How to Back Up and Restore Databases Used Through ScalarDB"
+        url: /docs/3.10/backup-restore/
+      - title: "Managing ScalarDB on Managed Kubernetes Services"
+        url: /docs/3.10/scalar-kubernetes/manage-kubernetes/
+  # Migrate docs
+  # - title: "Migrate"
+  #   children:
+  #     - title: ""
+  #       url: 
+  # Reference docs
+  - title: "Reference"
+    children:
+      - title: "ScalarDB Design Document"
+        url: /docs/3.10/design/
+      - title: "ScalarDB Supported Databases"
+        url: /docs/3.10/scalardb-supported-databases/
+      - title: "Requirements and Recommendations for the Underlying Databases of ScalarDB"
+        url: /docs/3.10/requirements/
+      - title: "Storage Abstraction and API Guide"
+        url: /docs/3.10/storage-abstraction/
+      - title: "ScalarDB Benchmarks"
+        url: /docs/3.10/scalardb-benchmarks/README/
+      - title: "ScalarDB Cluster"
+        url: /docs/3.10/scalardb-cluster/
+      - title: "ScalarDB SQL Grammar"
+        url: /docs/3.10/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.9":
   - title: "⬅ ScalarDB Enterprise docs home" 
     url: /docs # Don't change this URL. This links back to the parent product home page.

docs/3.10/scalardb-cluster/standalone-mode/docker-compose.yaml

@@ -0,0 +1,28 @@
+version: "3.5"
+services:
+
+  postgresql:
+    container_name: "postgresql"
+    image: "postgres:15"
+    ports:
+      - 5432:5432
+    environment:
+      - POSTGRES_PASSWORD=postgres
+    healthcheck:
+      test: ["CMD-SHELL", "pg_isready || exit 1"]
+      interval: 1s
+      timeout: 10s
+      retries: 60
+      start_period: 30s
+
+  scalardb-cluster-standalone:
+    container_name: "scalardb-cluser-node"
+    image: "ghcr.io/scalar-labs/scalardb-cluster-node:4.0.0-SNAPSHOT"
+    ports:
+      - 60053:60053
+      - 8080:8080
+    volumes:
+      - ./scalardb-cluster-node.properties:/scalardb-cluster/node/scalardb-cluster-node.properties
+    depends_on:
+      postgresql:
+        condition: service_healthy

docs/3.10/scalardb-cluster/standalone-mode/scalardb-cluster-node.properties

@@ -0,0 +1,5 @@
+scalar.db.storage=jdbc
+scalar.db.contact_points=jdbc:postgresql://postgresql:5432/postgres
+scalar.db.username=postgres
+scalar.db.password=postgres
+scalar.db.cluster.node.standalone_mode.enabled=true

docs/3.11/add-scalardb-to-your-build.md

@@ -0,0 +1,37 @@
+# Add ScalarDB to Your Build
+
+The ScalarDB library is available on the [Maven Central Repository](https://mvnrepository.com/artifact/com.scalar-labs/scalardb). You can add the library as a build dependency to your application by using Gradle or Maven.
+
+## Configure your application based on your build tool
+
+Select your build tool, and follow the instructions to add the build dependency for ScalarDB to your application.
+
+<div id="tabset-1">
+<div class="tab">
+  <button class="tablinks" onclick="openTab(event, 'Gradle', 'tabset-1')" id="defaultOpen-1">Gradle</button>
+  <button class="tablinks" onclick="openTab(event, 'Maven', 'tabset-1')">Maven</button>
+</div>
+
+<div id="Gradle" class="tabcontent" markdown="1">
+
+To add the build dependency for ScalarDB by using Gradle, add the following to `build.gradle` in your application, replacing `<VERSION>` with the version of ScalarDB that you want to use:
+
+```gradle
+dependencies {
+  implementation 'com.scalar-labs:scalardb:<VERSION>'
+}
+```
+</div>
+<div id="Maven" class="tabcontent" markdown="1">
+
+To add the build dependency for ScalarDB by using Maven, add the following to `pom.xml` in your application, replacing `<VERSION>` with the version of ScalarDB that you want to use:
+
+```xml
+<dependency>
+  <groupId>com.scalar-labs</groupId>
+  <artifactId>scalardb</artifactId>
+  <version><VERSION></version>
+</dependency>
+```
+</div>
+</div>