AUTO: Sync ScalarDL docs (versioned) to docs site repo

scalar-labs · Feb 14, 2024 · f9688fa · f9688fa
1 parent 7a12195
commit f9688fa
Show file tree

Hide file tree

Showing 30,166 changed files with 9,544,121 additions and 78 deletions.
diff --git a/docs/3.4/applications/escrow-payment/README.md b/docs/3.4/applications/escrow-payment/README.md
@@ -1,5 +1,3 @@
-{% include scalardl/end-of-support.html %}
-
 # ScalarDL Escrow payment CLI
 
 The following is a simple Java CLI application to try out and test [ScalarDL](https://github.com/scalar-labs/scalardl). PicoCLI is used as a CLI framework.

diff --git a/docs/3.4/applications/simple-bank-account/README.md b/docs/3.4/applications/simple-bank-account/README.md
@@ -1,5 +1,3 @@
-{% include scalardl/end-of-support.html %}
-
 # A simple bank account application
 
 ## Overview

diff --git a/docs/3.4/applications/simple-bank-account/docs/api_endpoints.md b/docs/3.4/applications/simple-bank-account/docs/api_endpoints.md
@@ -1,5 +1,3 @@
-{% include scalardl/end-of-support.html %}
-
 # API endpoints
 
 ## `GET v1/accounts`

diff --git a/docs/3.4/authentication.md b/docs/3.4/authentication.md
@@ -1,5 +1,3 @@
-{% include scalardl/end-of-support.html %}
-
 # ScalarDL Authentication Guide
 
 This document explains the ScalarDL authentication mechanism and how to use it properly. 

diff --git a/docs/3.4/backup-restore.md b/docs/3.4/backup-restore.md
@@ -1,5 +1,3 @@
-{% include scalardl/end-of-support.html %}
-
 # A Guide on How to Backup and Restore Data in ScalarDL
 
 Since ScalarDL uses ScalarDB that provides transaction capability on top of non-transactional (possibly transactional) databases non-invasively,

diff --git a/docs/3.4/ca/caclient-getting-started.md b/docs/3.4/ca/caclient-getting-started.md
@@ -1,5 +1,3 @@
-{% include scalardl/end-of-support.html %}
-
 # How to get a certificate
 
 This document describes how to get a certificate to enroll in ScalarDL network.

diff --git a/docs/3.4/ca/caserver-getting-started.md b/docs/3.4/ca/caserver-getting-started.md
@@ -1,5 +1,3 @@
-{% include scalardl/end-of-support.html %}
-
 # How to start CA sever with CFSSL
 
 This document describes how to start CA server with CFSSL.

diff --git a/docs/3.4/compatibility.md b/docs/3.4/compatibility.md
@@ -1,5 +1,3 @@
-{% include scalardl/end-of-support.html %}
-
 # ScalarDL Compatibility Matrix
 
 This document shows ScalarDL Ledger and Auditor compatibility with the ScalarDL Java Client SDK.

diff --git a/docs/3.4/design.md b/docs/3.4/design.md
@@ -1,5 +1,3 @@
-{% include scalardl/end-of-support.html %}
-
 # ScalarDL Design Document
 
 For details about the design and implementation of ScalarDL, please see the following documents, which we presented at the VLDB 2022 conference:

diff --git a/docs/3.4/getting-started-auditor.md b/docs/3.4/getting-started-auditor.md
@@ -1,5 +1,3 @@
-{% include scalardl/end-of-support.html %}
-
 # Getting Started with ScalarDL Auditor
 
 This document explains how to get started with ScalarDL Auditor.

diff --git a/docs/3.4/getting-started.md b/docs/3.4/getting-started.md
@@ -1,5 +1,3 @@
-{% include scalardl/end-of-support.html %}
-
 # Getting Started with ScalarDL
 
 This document explains how to get started with ScalarDL by running your first simple contract using the Client SDK.

diff --git a/docs/3.4/how-to-handle-errors.md b/docs/3.4/how-to-handle-errors.md
@@ -1,5 +1,3 @@
-{% include scalardl/end-of-support.html %}
-
 # A Guide on How to Handle Errors in ScalarDL
 
 This document sets out some guidelines for handling errors in ScalarDL.

diff --git a/docs/3.4/how-to-use-proof.md b/docs/3.4/how-to-use-proof.md
@@ -1,5 +1,3 @@
-{% include scalardl/end-of-support.html %}
-
 # A Guide on How to Use Asset Proofs in ScalarDL
 
 This document sets out some guidelines for using Asset Proofs in ScalarDL.

diff --git a/docs/3.4/how-to-write-contract.md b/docs/3.4/how-to-write-contract.md
@@ -1,5 +1,3 @@
-{% include scalardl/end-of-support.html %}
-
 # A Guide on How to Write a Good Contract for ScalarDL
 
 This document sets out some guidelines for writing contracts for ScalarDL.

diff --git a/docs/3.4/how-to-write-function.md b/docs/3.4/how-to-write-function.md
@@ -1,5 +1,3 @@
-{% include scalardl/end-of-support.html %}
-
 # A Guide on How to Write Function for ScalarDL
 
 This document sets out some guidelines for writing functions for ScalarDL.

diff --git a/docs/3.4/implementation.md b/docs/3.4/implementation.md
@@ -1,5 +1,3 @@
-{% include scalardl/end-of-support.html %}
-
 # ScalarDL Implementation
 
 ScalarDL is scalable and practical Byzantine fault detection middleware for transactional database systems, which achieves correctness, scalability, and database agnosticism.

diff --git a/docs/3.4/index.md b/docs/3.4/index.md
@@ -1,5 +1,3 @@
-{% include scalardl/end-of-support.html %}
-
 # ScalarDL: Byzantine Fault Detection Middleware for Transactional Database Systems
 
 ScalarDL is scalable and practical Byzantine fault detection middleware for transactional database systems that achieves correctness, scalability, and database agnosticism.

diff --git a/docs/3.4/installation-with-docker.md b/docs/3.4/installation-with-docker.md
@@ -1,5 +1,3 @@
-{% include scalardl/end-of-support.html %}
-
 # How to install ScalarDL in your local environment with Docker
 
 This document shows how to set up a local environment that runs ScalarDL

diff --git a/docs/3.4/javadoc/2.1.1/index.md b/docs/3.4/javadoc/2.1.1/index.md
@@ -1,5 +1,3 @@
-{% include scalardl/end-of-support.html %}
-
 * [client](./client)
 * [common](./common)
 * [ledger](./ledger)

diff --git a/docs/3.4/javadoc/2.2.0/index.md b/docs/3.4/javadoc/2.2.0/index.md
@@ -1,5 +1,3 @@
-{% include scalardl/end-of-support.html %}
-
 * [client](./client)
 * [common](./common)
 * [ledger](./ledger)

diff --git a/docs/3.4/javadoc/3.0.0/index.md b/docs/3.4/javadoc/3.0.0/index.md
@@ -1,5 +1,3 @@
-{% include scalardl/end-of-support.html %}
-
 * [auditor](./auditor)
 * [client](./client)
 * [common](./common)

diff --git a/docs/3.4/javadoc/3.0.2/index.md b/docs/3.4/javadoc/3.0.2/index.md
@@ -1,5 +1,3 @@
-{% include scalardl/end-of-support.html %}
-
 * [auditor](./auditor)
 * [client](./client)
 * [common](./common)

diff --git a/docs/3.4/javadoc/3.1.0/index.md b/docs/3.4/javadoc/3.1.0/index.md
@@ -1,5 +1,3 @@
-{% include scalardl/end-of-support.html %}
-
 * [auditor](./auditor)
 * [bfd](./bfd)
 * [client](./client)

diff --git a/docs/3.4/javadoc/3.2.0/index.md b/docs/3.4/javadoc/3.2.0/index.md
@@ -1,5 +1,3 @@
-{% include scalardl/end-of-support.html %}
-
 * [auditor](./auditor)
 * [client](./client)
 * [common](./common)

diff --git a/docs/3.4/javadoc/3.3.0/index.md b/docs/3.4/javadoc/3.3.0/index.md
@@ -1,5 +1,3 @@
-{% include scalardl/end-of-support.html %}
-
 * [auditor](./auditor)
 * [client](./client)
 * [common](./common)

diff --git a/docs/3.4/javadoc/index.md b/docs/3.4/javadoc/index.md
@@ -1,5 +1,3 @@
-{% include scalardl/end-of-support.html %}
-
 # Scalar DL Javadoc
 
 * [latest](./latest/index.md)

diff --git a/docs/3.4/scalardl-benchmarks/README.md b/docs/3.4/scalardl-benchmarks/README.md
@@ -1,5 +1,3 @@
-{% include scalardl/end-of-support.html %}
-
 # ScalarDL Benchmarks
 
 This repository contains benchmark programs for ScalarDL.

diff --git a/docs/3.4/scalardl-go-client-sdk/README.md b/docs/3.4/scalardl-go-client-sdk/README.md
@@ -1,5 +1,3 @@
-{% include scalardl/end-of-support.html %}
-
 # Scalar DL Go Client SDK
 This module is for developing applications that interact with [Scalar DL](https://github.com/scalar-labs/scalardl) networks.
 

diff --git a/docs/3.4/scalardl-java-client-sdk/README.md b/docs/3.4/scalardl-java-client-sdk/README.md
@@ -1,5 +1,3 @@
-{% include scalardl/end-of-support.html %}
-
 ## Scalar DL Java Client SDK
 
 This is a client-side Java library to interact with [Scalar DL](https://github.com/scalar-labs/scalardl) network.

diff --git a/docs/3.4/scalardl-javascript-sdk-base/README.md b/docs/3.4/scalardl-javascript-sdk-base/README.md
@@ -1,5 +1,3 @@
-{% include scalardl/end-of-support.html %}
-
 [![CircleCI](https://circleci.com/gh/scalar-labs/scalardl-javascript-sdk-base/tree/master.svg?style=svg)](https://circleci.com/gh/scalar-labs/scalardl-javascript-sdk-base/tree/master)
 
 NPM package `@scalar-labs/scalardl-javascript-sdk-base` is the common part for package [@scalar-labs/scalardl-web-client-sdk](https://github.com/scalar-labs/scalardl-web-client-sdk) and [@scalar-labs/scalardl-node-client-sdk](https://github.com/scalar-labs/scalardl-node-client-sdk).

diff --git a/docs/3.4/scalardl-node-client-sdk/README.md b/docs/3.4/scalardl-node-client-sdk/README.md
@@ -1,5 +1,3 @@
-{% include scalardl/end-of-support.html %}
-
 # Scalar DL Node Client SDK
 
 This is a library for Node.js applications by which the applications can interact with a [Scalar DL](https://github.com/scalar-labs/scalardl) network.

diff --git a/docs/3.4/scalardl-web-client-sdk/README.md b/docs/3.4/scalardl-web-client-sdk/README.md
@@ -1,5 +1,3 @@
-{% include scalardl/end-of-support.html %}
-
 ## Scalar DL Web Client SDK
 
 This is a library for web applications by which the applications can interact with a [Scalar DL](https://github.com/scalar-labs/scalardl) network.

diff --git a/docs/3.4/schema-loader.md b/docs/3.4/schema-loader.md
@@ -1,5 +1,3 @@
-{% include scalardl/end-of-support.html %}
-
 # ScalarDL Schema Loader
 
 A Docker image that loads the database schemas of ScalarDL using [Schema Tool for Scalar DB](https://github.com/scalar-labs/scalardb/tree/master/schema-loader/).

diff --git a/docs/3.4/sdks.md b/docs/3.4/sdks.md
@@ -1,5 +1,3 @@
-{% include scalardl/end-of-support.html %}
-
 # SDKs for ScalarDL
 
 The following is a list of SDKs for ScalarDL:

diff --git a/docs/3.4/troubleshooting-guide.md b/docs/3.4/troubleshooting-guide.md
@@ -1,5 +1,3 @@
-{% include scalardl/end-of-support.html %}
-
 # Troubleshooting Guide
 
 # Introduction

diff --git a/docs/3.7/getting-started.md b/docs/3.7/getting-started.md
@@ -15,6 +15,44 @@ The Client SDK is a set of user-facing programs to interact with Ledger and Audi
 ScalarDL (Ledger and Auditor) abstracts data as a set of assets, where each asset is composed of the history of a record identified by a key called `asset_id` and a historical version number called `age`.
 In this document, you will create a very simple application to manage an asset's status using ScalarDL Client SDK.
 
+## Install a JDK
+
+Because ScalarDL is written in Java, using Java is one of the easiest ways to build a ScalarDL applications.
+In such a case, you must have one of the following Java Development Kits (JDKs) installed in your environment:
+
+- [Oracle JDK](https://www.oracle.com/java/technologies/downloads/) LTS version (8, 11, or 17)
+- [OpenJDK](https://openjdk.org/install/) LTS version (8, 11, or 17)
+
+{% capture notice--warning %}
+**Attention**
+
+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 as follows.
+
+```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).
+{% endcapture %}
+
+<div class="notice--warning">{{ notice--warning | markdownify }}</div>
+
+{% capture notice--info %}
+**Note**
+
+We recommend using the LTS versions mentioned above, but other non-LTS versions may work.
+
+In addition, other JDKs should work with ScalarDL, but we haven't tested them.
+{% endcapture %}
+
+<div class="notice--info">{{ notice--info | markdownify }}</div>
+
 ## Download the Client SDK
 
 The Client SDK library is available on [Maven Central](https://search.maven.org/search?q=a:scalardl-java-client-sdk). You can install it in your application using your build tool such as Gradle.
@@ -77,7 +115,7 @@ Next, let's register your certificate to ScalarDL Ledger. Please check [caclient
 This time, let's use a simple tool to register your certificate as follows.
 
 ```shell
-client/bin/register-cert --properties client.properties
+client/bin/scalardl register-cert --properties client.properties
 ```
 
 The registered certificate will allow you to register and execute contracts and will also be used for detecting Byzantine faults in databases.
@@ -138,7 +176,7 @@ This will generate `build/classes/java/main/com/org1/contract/StateUpdater.class
 Let's register your contract. Here again we use a simple tool.
 
 ```shell
-client/bin/register-contract --properties client.properties --contract-id StateUpdater --contract-binary-name com.org1.contract.StateUpdater --contract-class-file build/classes/java/main/com/org1/contract/StateUpdater.class
+client/bin/scalardl register-contract --properties client.properties --contract-id StateUpdater --contract-binary-name com.org1.contract.StateUpdater --contract-class-file build/classes/java/main/com/org1/contract/StateUpdater.class
 ```
 
 Please set a globally unique ID for the contract ID (e.g. `StateUpdater` in the above command).
@@ -151,7 +189,7 @@ For example, let's think about a voting application. In the application, anyone
 Now you are ready to execute the contract with the following command.
 
 ```shell
-client/bin/execute-contract --properties client.properties --contract-id StateUpdater --contract-argument '{"asset_id":"some_asset", "state":3}'
+client/bin/scalardl execute-contract --properties client.properties --contract-id StateUpdater --contract-argument '{"asset_id":"some_asset", "state":3}'
 ```
 
 In the contract argument, the value specified with the key `asset_id` must be unique globally for each asset.
@@ -161,7 +199,7 @@ In the contract argument, the value specified with the key `asset_id` must be un
 You can validate the states of Ledger by executing the following command.
 
 ```shell
-client/bin/validate-ledger --properties client.properties --asset-id="some_asset"
+client/bin/scalardl validate-ledger --properties client.properties --asset-id="some_asset"
 ```
 
 What the validation does is depending on how you set up and configure ScalarDL.

diff --git a/docs/3.8/getting-started.md b/docs/3.8/getting-started.md
@@ -15,6 +15,44 @@ The Client SDK is a set of user-facing programs to interact with Ledger and Audi
 ScalarDL (Ledger and Auditor) abstracts data as a set of assets, where each asset is composed of the history of a record identified by a key called `asset_id` and a historical version number called `age`.
 In this document, you will create a very simple application to manage an asset's status using ScalarDL Client SDK.
 
+## Install a JDK
+
+Because ScalarDL is written in Java, using Java is one of the easiest ways to build a ScalarDL applications.
+In such a case, you must have one of the following Java Development Kits (JDKs) installed in your environment:
+
+- [Oracle JDK](https://www.oracle.com/java/technologies/downloads/) LTS version (8, 11, or 17)
+- [OpenJDK](https://openjdk.org/install/) LTS version (8, 11, or 17)
+
+{% capture notice--warning %}
+**Attention**
+
+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 as follows.
+
+```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).
+{% endcapture %}
+
+<div class="notice--warning">{{ notice--warning | markdownify }}</div>
+
+{% capture notice--info %}
+**Note**
+
+We recommend using the LTS versions mentioned above, but other non-LTS versions may work.
+
+In addition, other JDKs should work with ScalarDL, but we haven't tested them.
+{% endcapture %}
+
+<div class="notice--info">{{ notice--info | markdownify }}</div>
+
 ## Download the Client SDK
 
 The Client SDK library is available on [Maven Central](https://search.maven.org/search?q=a:scalardl-java-client-sdk). You can install it in your application using your build tool such as Gradle.
@@ -77,7 +115,7 @@ Next, let's register your certificate to ScalarDL Ledger. Please check [caclient
 This time, let's use a simple tool to register your certificate as follows.
 
 ```shell
-client/bin/register-cert --properties client.properties
+client/bin/scalardl register-cert --properties client.properties
 ```
 
 The registered certificate will allow you to register and execute contracts and will also be used for detecting Byzantine faults in databases.
@@ -138,7 +176,7 @@ This will generate `build/classes/java/main/com/org1/contract/StateUpdater.class
 Let's register your contract. Here again we use a simple tool.
 
 ```shell
-client/bin/register-contract --properties client.properties --contract-id StateUpdater --contract-binary-name com.org1.contract.StateUpdater --contract-class-file build/classes/java/main/com/org1/contract/StateUpdater.class
+client/bin/scalardl register-contract --properties client.properties --contract-id StateUpdater --contract-binary-name com.org1.contract.StateUpdater --contract-class-file build/classes/java/main/com/org1/contract/StateUpdater.class
 ```
 
 Please set a globally unique ID for the contract ID (e.g. `StateUpdater` in the above command).
@@ -151,7 +189,7 @@ For example, let's think about a voting application. In the application, anyone
 Now you are ready to execute the contract with the following command.
 
 ```shell
-client/bin/execute-contract --properties client.properties --contract-id StateUpdater --contract-argument '{"asset_id":"some_asset", "state":3}'
+client/bin/scalardl execute-contract --properties client.properties --contract-id StateUpdater --contract-argument '{"asset_id":"some_asset", "state":3}'
 ```
 
 In the contract argument, the value specified with the key `asset_id` must be unique globally for each asset.
@@ -161,7 +199,7 @@ In the contract argument, the value specified with the key `asset_id` must be un
 You can validate the states of Ledger by executing the following command.
 
 ```shell
-client/bin/validate-ledger --properties client.properties --asset-id="some_asset"
+client/bin/scalardl validate-ledger --properties client.properties --asset-id="some_asset"
 ```
 
 What the validation does is depending on how you set up and configure ScalarDL.

diff --git a/docs/ja-jp/3.4/applications/escrow-payment/.gitattributes b/docs/ja-jp/3.4/applications/escrow-payment/.gitattributes
@@ -0,0 +1,6 @@
+#
+# https://help.github.com/articles/dealing-with-line-endings/
+#
+# These are explicitly windows files and should use crlf
+*.bat           text eol=crlf
+