Merge pull request #27 from scalar-labs/update-samples-instructions

Add instructions to clone the ScalarDB samples repository
scalar-labs · Jul 13, 2023 · 9dc6dd8 · 9dc6dd8
2 parents 3402c66 + 1c898e6
commit 9dc6dd8
Show file tree

Hide file tree

Showing 26 changed files with 374 additions and 0 deletions.
diff --git a/docs/3.4/scalardb-samples/microservice-transaction-sample/README.md b/docs/3.4/scalardb-samples/microservice-transaction-sample/README.md
@@ -164,6 +164,20 @@ And the `repayment` endpoint of Customer Service is for transaction #5.
 
 ## Setup
 
+### Clone the ScalarDB samples repository
+
+Open Terminal, then clone the ScalarDB samples repository by running the following command:
+
+```shell
+$ git clone https://github.com/scalar-labs/scalardb-samples
+```
+
+Then, go to the directory with this sample by running the following command:
+
+```shell
+$ cd scalardb-samples/microservice-transaction-sample
+```
+
 ### Start Cassandra and MySQL
 
 To start Cassandra and MySQL, you need to run the following `docker-compose` command:

diff --git a/docs/3.4/scalardb-samples/multi-storage-transaction-sample/README.md b/docs/3.4/scalardb-samples/multi-storage-transaction-sample/README.md
@@ -136,6 +136,20 @@ For details, please see [Configuration - Multi-storage Transactions](https://git
 
 ## Setup
 
+### Clone the ScalarDB samples repository
+
+Open Terminal, then clone the ScalarDB samples repository by running the following command:
+
+```shell
+$ git clone https://github.com/scalar-labs/scalardb-samples
+```
+
+Then, go to the directory with this sample by running the following command:
+
+```shell
+$ cd scalardb-samples/multi-storage-transaction-sample
+```
+
 ### Start Cassandra and MySQL
 
 To start Cassandra and MySQL, you need to run the following `docker-compose` command:

diff --git a/docs/3.4/scalardb-samples/scalardb-sample/README.md b/docs/3.4/scalardb-samples/scalardb-sample/README.md
@@ -119,6 +119,20 @@ Since this sample application uses Cassandra, as shown above, you need to config
 
 ## Setup
 
+### Clone the ScalarDB samples repository
+
+Open Terminal, then clone the ScalarDB samples repository by running the following command:
+
+```shell
+$ git clone https://github.com/scalar-labs/scalardb-samples
+```
+
+Then, go to the directory with this sample by running the following command:
+
+```shell
+$ cd scalardb-samples/scalardb-sample
+```
+
 ### Start Cassandra
 
 To start Cassandra, you need to run the following `docker-compose` command:

diff --git a/docs/3.4/scalardb-samples/scalardb-server-sample/README.md b/docs/3.4/scalardb-samples/scalardb-server-sample/README.md
@@ -33,6 +33,22 @@ scalar.db.password=cassandra
 scalar.db.storage=cassandra
 ```
 
+#### Clone the ScalarDB samples repository
+
+Open Terminal, then clone the ScalarDB samples repository by running the following command:
+
+```shell
+$ git clone https://github.com/scalar-labs/scalardb-samples
+```
+
+Then, go to the directory with this sample by running the following command:
+
+```shell
+$ cd scalardb-samples/scalardb-server-sample
+```
+
+#### Start Cassandra
+
 To start Cassandra and ScalarDB Server, we use the following command.
 Please note that we should wait around a bit more than one minute because ScalarDB container has to wait for Cassandra container to be fully started.
 ```shell

diff --git a/docs/3.5/scalardb-samples/microservice-transaction-sample/README.md b/docs/3.5/scalardb-samples/microservice-transaction-sample/README.md
@@ -164,6 +164,20 @@ And the `repayment` endpoint of Customer Service is for transaction #5.
 
 ## Setup
 
+### Clone the ScalarDB samples repository
+
+Open Terminal, then clone the ScalarDB samples repository by running the following command:
+
+```shell
+$ git clone https://github.com/scalar-labs/scalardb-samples
+```
+
+Then, go to the directory with this sample by running the following command:
+
+```shell
+$ cd scalardb-samples/microservice-transaction-sample
+```
+
 ### Start Cassandra and MySQL
 
 To start Cassandra and MySQL, you need to run the following `docker-compose` command:

diff --git a/docs/3.5/scalardb-samples/multi-storage-transaction-sample/README.md b/docs/3.5/scalardb-samples/multi-storage-transaction-sample/README.md
@@ -136,6 +136,20 @@ For details, please see [Configuration - Multi-storage Transactions](https://git
 
 ## Setup
 
+### Clone the ScalarDB samples repository
+
+Open Terminal, then clone the ScalarDB samples repository by running the following command:
+
+```shell
+$ git clone https://github.com/scalar-labs/scalardb-samples
+```
+
+Then, go to the directory with this sample by running the following command:
+
+```shell
+$ cd scalardb-samples/multi-storage-transaction-sample
+```
+
 ### Start Cassandra and MySQL
 
 To start Cassandra and MySQL, you need to run the following `docker-compose` command:

diff --git a/docs/3.5/scalardb-samples/scalardb-sample/README.md b/docs/3.5/scalardb-samples/scalardb-sample/README.md
@@ -119,6 +119,20 @@ Since this sample application uses Cassandra, as shown above, you need to config
 
 ## Setup
 
+### Clone the ScalarDB samples repository
+
+Open Terminal, then clone the ScalarDB samples repository by running the following command:
+
+```shell
+$ git clone https://github.com/scalar-labs/scalardb-samples
+```
+
+Then, go to the directory with this sample by running the following command:
+
+```shell
+$ cd scalardb-samples/scalardb-sample
+```
+
 ### Start Cassandra
 
 To start Cassandra, you need to run the following `docker-compose` command:

diff --git a/docs/3.5/scalardb-samples/scalardb-server-sample/README.md b/docs/3.5/scalardb-samples/scalardb-server-sample/README.md
@@ -33,6 +33,22 @@ scalar.db.password=cassandra
 scalar.db.storage=cassandra
 ```
 
+#### Clone the ScalarDB samples repository
+
+Open Terminal, then clone the ScalarDB samples repository by running the following command:
+
+```shell
+$ git clone https://github.com/scalar-labs/scalardb-samples
+```
+
+Then, go to the directory with this sample by running the following command:
+
+```shell
+$ cd scalardb-samples/scalardb-server-sample
+```
+
+#### Start Cassandra
+
 To start Cassandra and ScalarDB Server, we use the following command.
 Please note that we should wait around a bit more than one minute because ScalarDB container has to wait for Cassandra container to be fully started.
 ```shell

diff --git a/docs/3.6/scalardb-samples/microservice-transaction-sample/README.md b/docs/3.6/scalardb-samples/microservice-transaction-sample/README.md
@@ -164,6 +164,20 @@ And the `repayment` endpoint of Customer Service is for transaction #5.
 
 ## Setup
 
+### Clone the ScalarDB samples repository
+
+Open Terminal, then clone the ScalarDB samples repository by running the following command:
+
+```shell
+$ git clone https://github.com/scalar-labs/scalardb-samples
+```
+
+Then, go to the directory with this sample by running the following command:
+
+```shell
+$ cd scalardb-samples/microservice-transaction-sample
+```
+
 ### Start Cassandra and MySQL
 
 To start Cassandra and MySQL, you need to run the following `docker-compose` command:

diff --git a/docs/3.6/scalardb-samples/multi-storage-transaction-sample/README.md b/docs/3.6/scalardb-samples/multi-storage-transaction-sample/README.md
@@ -136,6 +136,20 @@ For details, please see [Configuration - Multi-storage Transactions](https://git
 
 ## Setup
 
+### Clone the ScalarDB samples repository
+
+Open Terminal, then clone the ScalarDB samples repository by running the following command:
+
+```shell
+$ git clone https://github.com/scalar-labs/scalardb-samples
+```
+
+Then, go to the directory with this sample by running the following command:
+
+```shell
+$ cd scalardb-samples/multi-storage-transaction-sample
+```
+
 ### Start Cassandra and MySQL
 
 To start Cassandra and MySQL, you need to run the following `docker-compose` command:

diff --git a/docs/3.6/scalardb-samples/scalardb-sample/README.md b/docs/3.6/scalardb-samples/scalardb-sample/README.md
@@ -119,6 +119,20 @@ Since this sample application uses Cassandra, as shown above, you need to config
 
 ## Setup
 
+### Clone the ScalarDB samples repository
+
+Open Terminal, then clone the ScalarDB samples repository by running the following command:
+
+```shell
+$ git clone https://github.com/scalar-labs/scalardb-samples
+```
+
+Then, go to the directory with this sample by running the following command:
+
+```shell
+$ cd scalardb-samples/scalardb-sample
+```
+
 ### Start Cassandra
 
 To start Cassandra, you need to run the following `docker-compose` command:

diff --git a/docs/3.6/scalardb-samples/scalardb-server-sample/README.md b/docs/3.6/scalardb-samples/scalardb-server-sample/README.md
@@ -33,6 +33,22 @@ scalar.db.password=cassandra
 scalar.db.storage=cassandra
 ```
 
+#### Clone the ScalarDB samples repository
+
+Open Terminal, then clone the ScalarDB samples repository by running the following command:
+
+```shell
+$ git clone https://github.com/scalar-labs/scalardb-samples
+```
+
+Then, go to the directory with this sample by running the following command:
+
+```shell
+$ cd scalardb-samples/scalardb-server-sample
+```
+
+#### Start Cassandra
+
 To start Cassandra and ScalarDB Server, we use the following command.
 Please note that we should wait around a bit more than one minute because ScalarDB container has to wait for Cassandra container to be fully started.
 ```shell

diff --git a/docs/3.7/scalardb-samples/microservice-transaction-sample/README.md b/docs/3.7/scalardb-samples/microservice-transaction-sample/README.md
@@ -164,6 +164,20 @@ And the `repayment` endpoint of Customer Service is for transaction #5.
 
 ## Setup
 
+### Clone the ScalarDB samples repository
+
+Open Terminal, then clone the ScalarDB samples repository by running the following command:
+
+```shell
+$ git clone https://github.com/scalar-labs/scalardb-samples
+```
+
+Then, go to the directory with this sample by running the following command:
+
+```shell
+$ cd scalardb-samples/microservice-transaction-sample
+```
+
 ### Start Cassandra and MySQL
 
 To start Cassandra and MySQL, you need to run the following `docker-compose` command:

diff --git a/docs/3.7/scalardb-samples/multi-storage-transaction-sample/README.md b/docs/3.7/scalardb-samples/multi-storage-transaction-sample/README.md
@@ -136,6 +136,20 @@ For details, please see [Configuration - Multi-storage Transactions](https://git
 
 ## Setup
 
+### Clone the ScalarDB samples repository
+
+Open Terminal, then clone the ScalarDB samples repository by running the following command:
+
+```shell
+$ git clone https://github.com/scalar-labs/scalardb-samples
+```
+
+Then, go to the directory with this sample by running the following command:
+
+```shell
+$ cd scalardb-samples/multi-storage-transaction-sample
+```
+
 ### Start Cassandra and MySQL
 
 To start Cassandra and MySQL, you need to run the following `docker-compose` command:

diff --git a/docs/3.7/scalardb-samples/scalardb-sample/README.md b/docs/3.7/scalardb-samples/scalardb-sample/README.md
@@ -119,6 +119,20 @@ Since this sample application uses Cassandra, as shown above, you need to config
 
 ## Setup
 
+### Clone the ScalarDB samples repository
+
+Open Terminal, then clone the ScalarDB samples repository by running the following command:
+
+```shell
+$ git clone https://github.com/scalar-labs/scalardb-samples
+```
+
+Then, go to the directory with this sample by running the following command:
+
+```shell
+$ cd scalardb-samples/scalardb-sample
+```
+
 ### Start Cassandra
 
 To start Cassandra, you need to run the following `docker-compose` command:

diff --git a/docs/3.7/scalardb-samples/scalardb-server-sample/README.md b/docs/3.7/scalardb-samples/scalardb-server-sample/README.md
@@ -33,6 +33,22 @@ scalar.db.password=cassandra
 scalar.db.storage=cassandra
 ```
 
+#### Clone the ScalarDB samples repository
+
+Open Terminal, then clone the ScalarDB samples repository by running the following command:
+
+```shell
+$ git clone https://github.com/scalar-labs/scalardb-samples
+```
+
+Then, go to the directory with this sample by running the following command:
+
+```shell
+$ cd scalardb-samples/scalardb-server-sample
+```
+
+#### Start Cassandra
+
 To start Cassandra and ScalarDB Server, we use the following command.
 Please note that we should wait around a bit more than one minute because ScalarDB container has to wait for Cassandra container to be fully started.
 ```shell

diff --git a/docs/3.8/scalardb-samples/microservice-transaction-sample/README.md b/docs/3.8/scalardb-samples/microservice-transaction-sample/README.md
@@ -164,6 +164,20 @@ And the `repayment` endpoint of Customer Service is for transaction #5.
 
 ## Setup
 
+### Clone the ScalarDB samples repository
+
+Open Terminal, then clone the ScalarDB samples repository by running the following command:
+
+```shell
+$ git clone https://github.com/scalar-labs/scalardb-samples
+```
+
+Then, go to the directory with this sample by running the following command:
+
+```shell
+$ cd scalardb-samples/microservice-transaction-sample
+```
+
 ### Start Cassandra and MySQL
 
 To start Cassandra and MySQL, you need to run the following `docker-compose` command:

diff --git a/docs/3.8/scalardb-samples/multi-storage-transaction-sample/README.md b/docs/3.8/scalardb-samples/multi-storage-transaction-sample/README.md
@@ -136,6 +136,20 @@ For details, please see [Configuration - Multi-storage Transactions](https://git
 
 ## Setup
 
+### Clone the ScalarDB samples repository
+
+Open Terminal, then clone the ScalarDB samples repository by running the following command:
+
+```shell
+$ git clone https://github.com/scalar-labs/scalardb-samples
+```
+
+Then, go to the directory with this sample by running the following command:
+
+```shell
+$ cd scalardb-samples/multi-storage-transaction-sample
+```
+
 ### Start Cassandra and MySQL
 
 To start Cassandra and MySQL, you need to run the following `docker-compose` command: