From b2ea7aa93eff22f361f99b51b28f11c595fce3e6 Mon Sep 17 00:00:00 2001 From: josh-wong Date: Mon, 7 Apr 2025 12:13:37 +0000 Subject: [PATCH] AUTO: Sync ScalarDB docs in English to docs site repo --- .../version-3.13/scalardb-analytics-spark/README.mdx | 2 +- .../scalardb-analytics-spark/getting-started.mdx | 2 +- versioned_docs/version-3.13/scalardb-server.mdx | 6 +----- .../version-3.13/scalardb-sql/getting-started-with-jdbc.mdx | 6 +++--- .../version-3.13/scalardb-sql/getting-started-with-sql.mdx | 6 +++--- versioned_docs/version-3.13/scalardb-sql/index.mdx | 2 +- 6 files changed, 10 insertions(+), 14 deletions(-) diff --git a/versioned_docs/version-3.13/scalardb-analytics-spark/README.mdx b/versioned_docs/version-3.13/scalardb-analytics-spark/README.mdx index da3af0a2c..e15a83d89 100644 --- a/versioned_docs/version-3.13/scalardb-analytics-spark/README.mdx +++ b/versioned_docs/version-3.13/scalardb-analytics-spark/README.mdx @@ -28,4 +28,4 @@ Since ScalarDB Analytics with Spark is provided as a Spark catalog plugin, you c * To run ad-hoc analytical queries or development applications by using ScalarDB Analytics with Spark, see [Getting Started with ScalarDB Analytics with Spark](getting-started.mdx). * For tutorials on how to use ScalarDB Analytics with Spark by using a sample dataset and application, see [Run Analytical Queries on Sample Data by Using ScalarDB Analytics with Spark](../scalardb-samples/scalardb-analytics-spark-sample/README.mdx). * For details on how to configure ScalarDB Analytics with Spark, see [Configuration of ScalarDB Analytics with Spark](configuration.mdx). -* For supported Spark and Scala versions, see [Version Compatibility of ScalarDB Analytics with Spark](version-compatibility.mdx) +* For supported Spark and Scala versions, see [Version Compatibility of ScalarDB Analytics with Spark](./version-compatibility.mdx) diff --git a/versioned_docs/version-3.13/scalardb-analytics-spark/getting-started.mdx b/versioned_docs/version-3.13/scalardb-analytics-spark/getting-started.mdx index 34efcab2f..5ef4af01d 100644 --- a/versioned_docs/version-3.13/scalardb-analytics-spark/getting-started.mdx +++ b/versioned_docs/version-3.13/scalardb-analytics-spark/getting-started.mdx @@ -58,7 +58,7 @@ Since ScalarDB Analytics with Spark is available on the Maven Central Repository ScalarDB Analytics with Spark offers different artifacts for various Spark and Scala versions, provided in the format `scalardb-analytics-spark-_`. Make sure that you select the artifact matching the Spark and Scala versions you're using. -For reference, see [Version Compatibility of ScalarDB Analytics with Spark](version-compatibility.mdx). +For reference, see [Version Compatibility of ScalarDB Analytics with Spark](./version-compatibility.mdx). ::: diff --git a/versioned_docs/version-3.13/scalardb-server.mdx b/versioned_docs/version-3.13/scalardb-server.mdx index 23cc53ad2..78ce05ded 100644 --- a/versioned_docs/version-3.13/scalardb-server.mdx +++ b/versioned_docs/version-3.13/scalardb-server.mdx @@ -162,11 +162,7 @@ scalar.db.grpc.max_inbound_metadata_size= ## Further reading -Please see the following sample to learn ScalarDB Server further: - -- [ScalarDB Server Sample](scalardb-samples/scalardb-server-sample/README.mdx) - -Please also see the following documents to learn how to deploy ScalarDB Server: +Please see the following documents to learn how to deploy ScalarDB Server: - [Deploy ScalarDB Server on AWS](scalar-kubernetes/ManualDeploymentGuideScalarDBServerOnEKS.mdx) - [Deploy ScalarDB Server on Azure](scalar-kubernetes/ManualDeploymentGuideScalarDBServerOnAKS.mdx) \ No newline at end of file diff --git a/versioned_docs/version-3.13/scalardb-sql/getting-started-with-jdbc.mdx b/versioned_docs/version-3.13/scalardb-sql/getting-started-with-jdbc.mdx index 3a7693488..f66c9c9e5 100644 --- a/versioned_docs/version-3.13/scalardb-sql/getting-started-with-jdbc.mdx +++ b/versioned_docs/version-3.13/scalardb-sql/getting-started-with-jdbc.mdx @@ -36,7 +36,7 @@ Also, you need to create coordinator tables that are used in transactions as fol ## Store & retrieve data -[`ElectronicMoney.java`](./getting-started-with-jdbc/src/main/java/sample/ElectronicMoney.java) is a simple electronic money application. +The following is a simple electronic money application. (Be careful: it is simplified for ease of reading and far from practical and is certainly not production-ready.) ```java @@ -184,7 +184,7 @@ public class ElectronicMoney { ``` Before you run the application, you need to specify your GitHub username and your personal access token to access our private Maven repository. -One of the ways to specify them is using environment variables as follows (See [build.gradle](./getting-started-with-jdbc/build.gradle)): +One of the ways to specify them is using environment variables as follows: ```console export GPR_USERNAME= @@ -225,6 +225,6 @@ These are just simple examples of how ScalarDB JDBC is used. For more informatio * [Getting Started with ScalarDB](../getting-started-with-scalardb.mdx) * [ScalarDB JDBC Guide](jdbc-guide.mdx) * [ScalarDB SQL Grammar](grammar.mdx) -* [ScalarDB SQL Command Line interface](command-line-interface.mdx) +* [ScalarDB SQL Command Line interface](../scalardb-cluster/developer-guide-for-scalardb-cluster-with-java-api.mdx#sql-cli) * [ScalarDB SQL Server](sql-server.mdx) * [ScalarDB SQL Configurations](configurations.mdx) diff --git a/versioned_docs/version-3.13/scalardb-sql/getting-started-with-sql.mdx b/versioned_docs/version-3.13/scalardb-sql/getting-started-with-sql.mdx index f59999e0b..f39e6a484 100644 --- a/versioned_docs/version-3.13/scalardb-sql/getting-started-with-sql.mdx +++ b/versioned_docs/version-3.13/scalardb-sql/getting-started-with-sql.mdx @@ -36,7 +36,7 @@ Also, you need to create coordinator tables that are used in transactions as fol ## Store & retrieve data -[`ElectronicMoney.java`](./getting-started-with-sql/src/main/java/sample/ElectronicMoney.java) is a simple electronic money application. +The following is a simple electronic money application. (Be careful: it is simplified for ease of reading and far from practical and is certainly not production-ready.) ```java @@ -172,7 +172,7 @@ public class ElectronicMoney { ``` Before you run the application, you need to specify your GitHub username and your personal access token to access our private Maven repository. -One of the ways to specify them is using environment variables as follows (See [build.gradle](./getting-started-with-sql/build.gradle)): +One of the ways to specify them is using environment variables as follows: ```console export GPR_USERNAME= @@ -213,6 +213,6 @@ These are just simple examples of how ScalarDB SQL is used. For more information * [Getting Started with ScalarDB](../getting-started-with-scalardb.mdx) * [ScalarDB SQL API Guide](sql-api-guide.mdx) * [ScalarDB SQL Grammar](grammar.mdx) -* [ScalarDB SQL Command Line interface](command-line-interface.mdx) +* [ScalarDB SQL Command Line interface](../scalardb-cluster/developer-guide-for-scalardb-cluster-with-java-api.mdx#sql-cli) * [ScalarDB SQL Server](sql-server.mdx) * [ScalarDB SQL Configurations](configurations.mdx) diff --git a/versioned_docs/version-3.13/scalardb-sql/index.mdx b/versioned_docs/version-3.13/scalardb-sql/index.mdx index dd5a5837d..f307fd57e 100644 --- a/versioned_docs/version-3.13/scalardb-sql/index.mdx +++ b/versioned_docs/version-3.13/scalardb-sql/index.mdx @@ -121,7 +121,7 @@ To add a dependency using Maven: - [ScalarDB SQL API Guide](sql-api-guide.mdx) - [ScalarDB JDBC Guide](jdbc-guide.mdx) - [ScalarDB SQL Grammar](grammar.mdx) -- [ScalarDB SQL Command Line interface](command-line-interface.mdx) +- [ScalarDB SQL Command Line interface](../scalardb-cluster/developer-guide-for-scalardb-cluster-with-java-api.mdx#sql-cli) - [ScalarDB SQL Server](sql-server.mdx) - [ScalarDB SQL Configurations](configurations.mdx) - [Guide of Spring Data JDBC for ScalarDB](spring-data-guide.mdx)