AUTO: Sync ScalarDL docs in English to docs site repo

josh-wong · josh-wong · commit dfcbecda493e · 2025-09-25T04:49:12.000Z
diff --git a/docs/applications/simple-bank-account/conf/client.properties b/docs/applications/simple-bank-account/conf/client.properties
@@ -1,5 +1,5 @@
 # Optional. A hostname or an IP address of the server. Use localhost by default if not specified.
-# It assuems that there is a single endpoint that is given by DNS or a load balancer.
+# It assumes that there is a single endpoint that is given by DNS or a load balancer.
 scalar.dl.client.server.host=localhost
 
 # Optional. A port number of the server. Use 50051 by default if not specified.
diff --git a/docs/getting-started.mdx b/docs/getting-started.mdx
@@ -8,13 +8,174 @@ displayed_sidebar: docsEnglish
 import Tabs from '@theme/Tabs';
 import TabItem from '@theme/TabItem';
 import JavadocLink from "/src/theme/JavadocLink.js";
-import StartupLedger from '/src/components/en-us/_getting-started-startup-ledger.mdx';
+import DbSpecificSteps from '/src/components/en-us/_getting-started-db-specific-steps.mdx';
 
 # Get Started with ScalarDL Ledger
 
 This getting started tutorial explains how to configure ScalarDL on your preferred database and illustrates the process of creating a simple application where the historical states of data are traced.
 
-<StartupLedger />
+## Prerequisites
+
+- One of the following Java Development Kits (JDKs):
+  - **[Oracle JDK](https://www.oracle.com/java/):** 8, 11, 17, or 21 (LTS versions)
+  - **[OpenJDK](https://openjdk.org/) ([Eclipse Temurin](https://adoptium.net/temurin/), [Amazon Corretto](https://aws.amazon.com/corretto/), or [Microsoft Build of OpenJDK](https://learn.microsoft.com/en-us/java/openjdk/)):** 8, 11, 17, or 21 (LTS versions)
+- [Docker](https://www.docker.com/get-started/) 20.10 or later with [Docker Compose](https://docs.docker.com/compose/install/) v2.20.0 or later
+
+:::warning
+
+Since ScalarDL is built with JDK 8, contracts must be a JDK 8–compatible binary. If you use a version other than JDK 8, you must configure your build tool to build the JDK 8–compatible binary. There are several ways to specify binary compatibility, including using the `--release 8` option for javac or setting Gradle or Maven configurations to use the JDK 8 toolchain. The following shows the configuration for Gradle:
+
+```gradle
+java {
+    toolchain {
+        languageVersion.set(JavaLanguageVersion.of(8))
+    }
+}
+```
+
+For more details about the Gradle and Maven configurations, see [Toolchains for JVM projects for Gradle](https://docs.gradle.org/current/userguide/toolchains.html) and [Guide to Using Toolchains for Maven](https://maven.apache.org/guides/mini/guide-using-toolchains.html).
+
+:::
+
+## Clone the ScalarDL samples repository
+
+Open **Terminal**, then clone the ScalarDL samples repository by running the following command:
+
+```console
+git clone https://github.com/scalar-labs/scalardl-samples
+```
+
+Then, go to the directory that contains the sample configuration by running the following command:
+
+```console
+cd scalardl-samples
+```
+
+## Start up ScalarDL with your preferred database
+
+Select your database, and follow the instructions to deploy ScalarDL Ledger with it. For a list of databases that ScalarDL supports, see [Databases](requirements.mdx#databases).
+
+<Tabs groupId="databases" queryString>
+  <TabItem value="mysql" label="MySQL" default>
+  <DbSpecificSteps productName="MySQL" shortName="mysql" />
+  </TabItem>
+
+  <TabItem value="postgres" label="PostgreSQL">
+  <DbSpecificSteps productName="PostgreSQL" shortName="postgres" />
+  </TabItem>
+
+  <TabItem value="oracle" label="Oracle Database">
+  <DbSpecificSteps productName="Oracle Database" shortName="oracle" />
+  </TabItem>
+
+  <TabItem value="sqlserver" label="SQL Server">
+  <DbSpecificSteps productName="SQL Server" shortName="sqlserver" />
+  </TabItem>
+
+  <TabItem value="dynamodb" label="DynamoDB">
+  <DbSpecificSteps productName="DynamoDB" shortName="dynamodb" />
+  </TabItem>
+
+  <TabItem value="cosmosdb" label="Cosmos DB for NoSQL">
+
+  <h3>Set up your license (Enterprise edition only)</h3>
+
+  If you're using the ScalarDL Enterprise edition, set up your license as follows. If you're using the Community edition, skip to the next section to start up ScalarDL.
+
+  <details>
+  <summary>See here to set up your license</summary>
+
+  1. Enable the Docker image for the Enterprise edition in the `cosmosdb/docker-compose-ledger.yml` file as follows:
+
+     - Before changing the image (default configuration):
+
+       ```yaml
+       services:
+         scalardl-ledger:
+           image: ghcr.io/scalar-labs/scalardl-ledger:${SCALARDL_VERSION}
+           # image: ghcr.io/scalar-labs/scalardl-ledger-byol:${SCALARDL_VERSION}
+       ```
+
+     - After changing the image:
+
+       ```yaml
+       services:
+         scalardl-ledger:
+           # image: ghcr.io/scalar-labs/scalardl-ledger:${SCALARDL_VERSION}
+           image: ghcr.io/scalar-labs/scalardl-ledger-byol:${SCALARDL_VERSION}
+       ```
+
+  2. Set your license key for ScalarDL Ledger. In the `cosmosdb/ledger.properties` file, replace `<SET_YOUR_LICENSE_KEY>` with your license key. For example:
+
+     ```properties
+     ##### PLEASE REPLACE THIS VALUE WITH YOUR LICENSE KEY (ENTERPRISE EDITION ONLY) #####
+     scalar.dl.licensing.license_key={"organization_name":"XXXXXXXX","expiration_date_time":"YYYY-MM-DDTHH:mm:SS+TIMEZONE","product_name":"ScalarDL Ledger","product_version":N,"license_type":"trial","signature":"XXXXXXXX"}
+     ##### PLEASE REPLACE THIS VALUE WITH YOUR LICENSE KEY (ENTERPRISE EDITION ONLY) #####
+     ```
+
+  3. To check the license, update the `cosmosdb/docker-compose-ledger.yml` file as follows. If you're using a trial license, skip this step.
+
+     - Before changing the certificate file path (default configuration):
+
+       ```yaml
+       services:
+         scalardl-ledger:
+           volumes:
+             - ./ledger.properties:/scalar/ledger/ledger.properties.tmpl
+             - ../fixture/ledger-key.pem:/scalar/ledger-key.pem
+             - ../fixture/trial-license-cert.pem:/scalar/license-cert.pem
+             # If you have a commercial license key, you must use `commercial-license-cert.pem` instead of `trial-license-cert.pem`.
+             # - ../fixture/commercial-license-cert.pem:/scalar/license-cert.pem
+       ```
+
+     - After changing the certificate file path:
+
+       ```yaml
+       services:
+         scalardl-ledger:
+           volumes:
+             - ./ledger.properties:/scalar/ledger/ledger.properties.tmpl
+             - ../fixture/ledger-key.pem:/scalar/ledger-key.pem
+             # - ../fixture/trial-license-cert.pem:/scalar/license-cert.pem
+             # If you have a commercial license key, you must use `commercial-license-cert.pem` instead of `trial-license-cert.pem`.
+             - ../fixture/commercial-license-cert.pem:/scalar/license-cert.pem
+       ```
+
+  </details>
+
+  <h3>Start up ScalarDL</h3>
+
+  You can start using ScalarDL Ledger by following the steps below:
+
+  1. Configure Cosmos DB for NoSQL.
+
+     To use Azure Cosmos DB for NoSQL, you must have an Azure account. If you don't have an Azure account, visit [Create an Azure Cosmos DB account](https://learn.microsoft.com/en-us/azure/cosmos-db/nosql/quickstart-portal#create-account).
+
+     After setting up Cosmos DB for NoSQL, modify the following items in `cosmodb/ledger.properties` based on your configuration of Cosmos DB for NoSQL.
+
+     ```properties
+     scalar.db.contact_points=<COSMOS_DB_FOR_NOSQL_URI>
+     scalar.db.password=<COSMOS_DB_FOR_NOSQL_KEY>
+     ```
+
+  2. Load the database schema for ScalarDL Ledger by running the following command:
+
+     ```console
+     docker compose -f cosmosdb/docker-compose-ledger.yml up -d scalardl-ledger-schema-loader
+     ```
+
+  3. Run ScalarDL Ledger by running the following command:
+
+     ```console
+     docker compose -f cosmosdb/docker-compose-ledger.yml up -d
+     ```
+  </TabItem>
+
+  <TabItem value="cassandra" label="Cassandra">
+  <DbSpecificSteps productName="Cassandra" shortName="cassandra" />
+  </TabItem>
+
+</Tabs>
 
 ## Download the Client SDK
 
diff --git a/docs/how-to-run-applications-with-auditor.mdx b/docs/how-to-run-applications-with-auditor.mdx
@@ -103,7 +103,6 @@ Because Auditor does not rely on the Consensus Commit transaction manager, you d
 While ScalarDL leverages ScalarDB, the following ScalarDB features are not compatible with the consistency guarantee mechanism of ScalarDL:
 
 - [Group commit for the Coordinator table](https://scalardb.scalar-labs.com/docs/latest/api-guide/#group-commit-for-the-coordinator-table) (`scalar.db.consensus_commit.coordinator.group_commit.enabled` must be `false`.)
-- Coordinator write omission optimization in [Performance-related configurations](https://scalardb.scalar-labs.com/docs/latest/configurations#performance-related-configurations) (`scalar.db.consensus_commit.coordinator.write_omission_on_read_only.enabled` must be `false`.)
 
 ### Decide which other configurations to use
 
diff --git a/docs/how-to-run-applications.mdx b/docs/how-to-run-applications.mdx
@@ -81,10 +81,9 @@ You can configure the isolation level of Ledger as follows. If you are unsure ab
 
 #### Limitations
 
-While ScalarDL leverages ScalarDB, the following ScalarDB features are not compatible with the consistency guarantee mechanism of ScalarDL:
+While ScalarDL leverages ScalarDB, the following ScalarDB feature is not compatible with the consistency guarantee mechanism of ScalarDL:
 
 - [Group commit for the Coordinator table](https://scalardb.scalar-labs.com/docs/latest/api-guide/#group-commit-for-the-coordinator-table) (`scalar.db.consensus_commit.coordinator.group_commit.enabled` must be `false`.)
-- Coordinator write omission optimization in [Performance-related configurations](https://scalardb.scalar-labs.com/docs/latest/configurations#performance-related-configurations) (`scalar.db.consensus_commit.coordinator.write_omission_on_read_only.enabled` must be `false`.)
 
 ### Decide which other configurations to use
 
diff --git a/docs/quickstart-overview.mdx b/docs/quickstart-overview.mdx
@@ -7,16 +7,6 @@ displayed_sidebar: docsEnglish
 
 # Quickstart Overview
 
-In this category, you can follow quickstart tutorials for how to get started with ScalarDL.
+In this category, you can follow quickstart tutorials for how to get started with running a basic contract through ScalarDL Ledger by using the Java Client SDK.
 
-ScalarDL offers two abstracted data stores for easy, seamless interaction with the ledger: HashStore and TableStore.
-
-* HashStore provides interfaces for ensuring the authenticity of objects and collections, making it ideal for chain-of-custody and similar applications.
-* TableStore offers an SQL-compatible interface for verifying table authenticity, enabling developers to build versatile, tamper-evident applications with familiar data models and interfaces.
-
-To get started, refer to the following guides:
-
-* [Get Started with ScalarDL HashStore](getting-started-hashstore.mdx)
-* [Get Started with ScalarDL TableStore](getting-started-tablestore.mdx)
-
-ScalarDL also includes primitive interfaces for more customized interactions with the ledger. To explore this approach, see [Get Started with ScalarDL Ledger](getting-started.mdx).
+To get started, see [Run a Contract Through ScalarDL Ledger](getting-started.mdx).
diff --git a/docs/scalardl-auditor-status-codes.mdx b/docs/scalardl-auditor-status-codes.mdx
@@ -125,15 +125,7 @@ The specified asset is not found.
 **Message**
 
 ```markdown
-Authentication between Ledger and Auditor is not correctly configured. Set %s along with a private key with %s or %s if you use digital signature authentication.
-```
-
-### `DL-AUDITOR-414003`
-
-**Message**
-
-```markdown
-Authentication between Ledger and Auditor is not correctly configured. Set %s if you use HMAC authentication.
+Authentication between Ledger and Auditor is not correctly configured. Set %s or set %s along with a private key with %s or %s.
 ```
 
 ## `DL-AUDITOR-5xxxx` status codes
diff --git a/docs/scalardl-client-status-codes.mdx b/docs/scalardl-client-status-codes.mdx
@@ -260,11 +260,3 @@ Shutting down the channel failed. Details: %s
 ```markdown
 Processing JSON failed. Details: %s
 ```
-
-### `DL-CLIENT-502005`
-
-**Message**
-
-```markdown
-Failed to load the class file. File: %s
-```
diff --git a/docs/scalardl-common-status-codes.mdx b/docs/scalardl-common-status-codes.mdx
@@ -278,7 +278,7 @@ The private key and certificate are required.
 **Message**
 
 ```markdown
-The certificate version must be greater than zero.
+The certificate version must be greater than or equal to zero.
 ```
 
 ### `DL-COMMON-414011`
@@ -294,7 +294,7 @@ A secret key is required for HMAC authentication.
 **Message**
 
 ```markdown
-The secret version for HMAC authentication must be greater than zero.
+The secret version for HMAC authentication must be greater than or equal to zero.
 ```
 
 ### `DL-COMMON-414013`
diff --git a/docs/scalardl-ledger-status-codes.mdx b/docs/scalardl-ledger-status-codes.mdx
@@ -190,7 +190,7 @@ The database operation in the function failed. Details: %s
 **Message**
 
 ```markdown
-Authentication between Ledger and Auditor is not correctly configured. Set a private key with %s or %s if you use digital signature authentication with Auditor enabled.
+Authentication between Ledger and Auditor is not correctly configured. Set %s or set a private key with %s or %s.
 ```
 
 ### `DL-LEDGER-414004`
