You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@linkis.apache.org by ca...@apache.org on 2023/06/19 01:48:10 UTC
[linkis-website] branch dev updated: Change dataSourceId to dataSourceName (#710)
This is an automated email from the ASF dual-hosted git repository.
casion pushed a commit to branch dev
in repository https://gitbox.apache.org/repos/asf/linkis-website.git
The following commit(s) were added to refs/heads/dev by this push:
new d5613f8e45 Change dataSourceId to dataSourceName (#710)
d5613f8e45 is described below
commit d5613f8e459508bbb262f49060108e498944e242
Author: ahaoyao <12...@users.noreply.github.com>
AuthorDate: Mon Jun 19 09:48:04 2023 +0800
Change dataSourceId to dataSourceName (#710)
* Change dataSourceId to dataSourceName
* Example of optimization supplementary explanation
---
community/how-to-contribute-to-website.md | 14 ++++++++++++++
docs/user-guide/datasource-manual.md | 18 ++++++++++--------
.../current/how-to-contribute-to-website.md | 14 ++++++++++++++
.../current/user-guide/datasource-manual.md | 18 ++++++++++--------
.../current/user-guide/datasource-manual.md | 18 ++++++++++--------
.../version-1.3.2/user-guide/datasource-manual.md | 18 ++++++++++--------
.../version-1.3.2/user-guide/datasource-manual.md | 18 ++++++++++--------
7 files changed, 78 insertions(+), 40 deletions(-)
diff --git a/community/how-to-contribute-to-website.md b/community/how-to-contribute-to-website.md
index 8a52e2f132..7caafeb7a0 100644
--- a/community/how-to-contribute-to-website.md
+++ b/community/how-to-contribute-to-website.md
@@ -160,6 +160,20 @@ Company logo Located in `static/home/user`, and the picture size must be 176 ×
### 3.10 Path specification
If you want to link from a markdown document to another, it is best to use absolute path. For example, if you want to link to `quick-deploy.md`, the path should be `/docs/deployment/quick-deploy.md`.
+### 3.11 Version document
+For version documents (i.e. the corresponding documents for each version)
+Next version document (corresponding to the upcoming version)
+CN: i18n/zh-CN/docusaurus-plugin-content-docs/current/xxx
+EN: versioned_docs/current/user-guide/xxx
+
+The latest version of the document (such as the document corresponding to the latest released version in 1.3.2)
+CN: i18n/zh-CN/docusaurus-plugin-content-docs/version-1.3.2/xxx
+EN: versioned_docs/version-1.3.2/xxx
+
+- If there are errors in stock documents (such as spelling errors, typos, formatting, etc.), it is best to adjust all versions, including both Chinese and English
+- If the content of the document is optimized and not related to the version (such as supplementary design documents), update the latest two versions of the document, including both Chinese and English
+- If it is a new version feature document that is strongly related to the version, such as the newly added feature description document in this version, it only needs to be added to the latest version document, including both Chinese and English
+
### English document title specification
English siderbar titles should be capitalized except for prepositions, and only the first word of the title in the markdwon document should be capitalized.
diff --git a/docs/user-guide/datasource-manual.md b/docs/user-guide/datasource-manual.md
index f6f2a393f4..676c11b99e 100644
--- a/docs/user-guide/datasource-manual.md
+++ b/docs/user-guide/datasource-manual.md
@@ -227,7 +227,8 @@ object TestMysqlClient {
//create data source
val dataSource = new DataSource();
- dataSource.setDataSourceName("for-mysql-test")
+ val dataSourceName = "for-mysql-test"
+ dataSource.setDataSourceName(dataSourceName)
dataSource.setDataSourceDesc("this is for mysql test")
dataSource.setCreateSystem(system)
dataSource.setDataSourceTypeId(1L)
@@ -273,14 +274,14 @@ object TestMysqlClient {
// use example
val metadataGetDatabasesAction: MetadataGetDatabasesAction = MetadataGetDatabasesAction.builder()
.setUser(user)
- .setDataSourceId(dataSourceId)
+ .setDataSourceName(dataSourceName)
.setSystem(system)
.build()
val metadataGetDatabasesResult: MetadataGetDatabasesResult = metaDataClient.getDatabases(metadataGetDatabasesAction)
val metadataGetTablesAction: MetadataGetTablesAction = MetadataGetTablesAction.builder()
.setUser(user)
- .setDataSourceId(dataSourceId)
+ .setDataSourceName(dataSourceName)
.setDatabase("linkis")
.setSystem(system)
.build()
@@ -288,7 +289,7 @@ object TestMysqlClient {
val metadataGetColumnsAction = MetadataGetColumnsAction.builder()
.setUser(user)
- .setDataSourceId(dataSourceId)
+ .setDataSourceName(dataSourceName)
.setDatabase("linkis")
.setSystem(system)
.setTable("linkis_datasource")
@@ -410,7 +411,8 @@ object TestHiveClient {
//create data source
val dataSource = new DataSource();
- dataSource.setDataSourceName("for-hive-test")
+ val dataSourceName = "for-hive-test"
+ dataSource.setDataSourceName(dataSourceName)
dataSource.setDataSourceDesc("this is for hive test")
dataSource.setCreateSystem(system)
dataSource.setDataSourceTypeId(4L)
@@ -450,14 +452,14 @@ object TestHiveClient {
// use example
val metadataGetDatabasesAction: MetadataGetDatabasesAction = MetadataGetDatabasesAction.builder()
.setUser(user)
- .setDataSourceId(dataSourceId)
+ .setDataSourceName(dataSourceName)
.setSystem(system)
.build()
val metadataGetDatabasesResult: MetadataGetDatabasesResult = metaDataClient.getDatabases(metadataGetDatabasesAction)
val metadataGetTablesAction: MetadataGetTablesAction = MetadataGetTablesAction.builder()
.setUser(user)
- .setDataSourceId(dataSourceId)
+ .setDataSourceName(dataSourceName)
.setDatabase("linkis_test_ind")
.setSystem(system)
.build()
@@ -467,7 +469,7 @@ object TestHiveClient {
val metadataGetColumnsAction = MetadataGetColumnsAction.builder()
.setUser(user)
- .setDataSourceId(dataSourceId)
+ .setDataSourceName(dataSourceName)
.setDatabase("linkis_test_ind")
.setSystem(system)
.setTable("test")
diff --git a/i18n/zh-CN/docusaurus-plugin-content-docs-community/current/how-to-contribute-to-website.md b/i18n/zh-CN/docusaurus-plugin-content-docs-community/current/how-to-contribute-to-website.md
index b3d74f7591..707a95e1f8 100644
--- a/i18n/zh-CN/docusaurus-plugin-content-docs-community/current/how-to-contribute-to-website.md
+++ b/i18n/zh-CN/docusaurus-plugin-content-docs-community/current/how-to-contribute-to-website.md
@@ -160,6 +160,20 @@ Visit the page https://linkis.apache.org/zh-CN/user
### 3.10 路径规范
如果希望想从一个markdown文档链接到另外一个文档, 最好使用绝对路径. 例如, 如果希望链接到 `quick-deploy.md`这个文档, 路径应写成 `/docs/deployment/quick-deploy.md`。
+### 3.11 版本文档
+对于版本文档（即每个版本对应的文档）
+下一个版本文档(next 即将发布的版本对应的文档)
+中文: i18n/zh-CN/docusaurus-plugin-content-docs/current/xxx
+英文: versioned_docs/current/user-guide/xxx
+
+最新的版本文档（如 1.3.2 最新发布的版本对应的文档 ）
+中文: i18n/zh-CN/docusaurus-plugin-content-docs/version-1.3.2/xxx
+英文: versioned_docs/version-1.3.2/xxx
+
+- 如果是存量文档的错误（如拼写 错别字 /格式等 ）最好所有版本都调整, 包括中英文
+- 如果文档的内容优化, 和版本不相关（如补充的设计文档）, 更新最近的两个版本文档, 包括中英文
+- 如果是新版本特性文档和版本强相关, 如本次版本新增的特性说明文档, 只需要补充至最新的版本文档中, 包括中英文
+
### 英文文档标题规范
英文文档侧边栏除介词外的所有词首字母使用大写, 同时英文markdown中的标题的第一个词首字母应大写，其他词首字母小写。
diff --git a/i18n/zh-CN/docusaurus-plugin-content-docs/current/user-guide/datasource-manual.md b/i18n/zh-CN/docusaurus-plugin-content-docs/current/user-guide/datasource-manual.md
index c62f0b0053..5bcc547edc 100644
--- a/i18n/zh-CN/docusaurus-plugin-content-docs/current/user-guide/datasource-manual.md
+++ b/i18n/zh-CN/docusaurus-plugin-content-docs/current/user-guide/datasource-manual.md
@@ -248,7 +248,8 @@ object TestMysqlClient {
//创建数据源
val dataSource = new DataSource();
- dataSource.setDataSourceName("for-mysql-test")
+ val dataSourceName = "for-mysql-test"
+ dataSource.setDataSourceName(dataSourceName)
dataSource.setDataSourceDesc("this is for mysql test")
dataSource.setCreateSystem(system)
dataSource.setDataSourceTypeId(1L)
@@ -294,14 +295,14 @@ object TestMysqlClient {
//使用示例
val metadataGetDatabasesAction: MetadataGetDatabasesAction = MetadataGetDatabasesAction.builder()
.setUser(user)
- .setDataSourceId(dataSourceId)
+ .setDataSourceName(dataSourceName)
.setSystem(system)
.build()
val metadataGetDatabasesResult: MetadataGetDatabasesResult = metaDataClient.getDatabases(metadataGetDatabasesAction)
val metadataGetTablesAction: MetadataGetTablesAction = MetadataGetTablesAction.builder()
.setUser(user)
- .setDataSourceId(dataSourceId)
+ .setDataSourceName(dataSourceName)
.setDatabase("linkis")
.setSystem(system)
.build()
@@ -309,7 +310,7 @@ object TestMysqlClient {
val metadataGetColumnsAction = MetadataGetColumnsAction.builder()
.setUser(user)
- .setDataSourceId(dataSourceId)
+ .setDataSourceName(dataSourceName)
.setDatabase("linkis")
.setSystem(system)
.setTable("linkis_datasource")
@@ -433,7 +434,8 @@ object TestHiveClient {
//创建数据源
val dataSource = new DataSource();
- dataSource.setDataSourceName("for-hive-test")
+ val dataSourceName = "for-hive-test"
+ dataSource.setDataSourceName(dataSourceName)
dataSource.setDataSourceDesc("this is for hive test")
dataSource.setCreateSystem(system)
dataSource.setDataSourceTypeId(4L)
@@ -473,14 +475,14 @@ object TestHiveClient {
//使用示例
val metadataGetDatabasesAction: MetadataGetDatabasesAction = MetadataGetDatabasesAction.builder()
.setUser(user)
- .setDataSourceId(dataSourceId)
+ .setDataSourceName(dataSourceName)
.setSystem(system)
.build()
val metadataGetDatabasesResult: MetadataGetDatabasesResult = metaDataClient.getDatabases(metadataGetDatabasesAction)
val metadataGetTablesAction: MetadataGetTablesAction = MetadataGetTablesAction.builder()
.setUser(user)
- .setDataSourceId(dataSourceId)
+ .setDataSourceName(dataSourceName)
.setDatabase("linkis_test_ind")
.setSystem(system)
.build()
@@ -490,7 +492,7 @@ object TestHiveClient {
val metadataGetColumnsAction = MetadataGetColumnsAction.builder()
.setUser(user)
- .setDataSourceId(dataSourceId)
+ .setDataSourceName(dataSourceName)
.setDatabase("linkis_test_ind")
.setSystem(system)
.setTable("test")
diff --git a/i18n/zh-CN/docusaurus-plugin-content-docs/version-1.3.2/current/user-guide/datasource-manual.md b/i18n/zh-CN/docusaurus-plugin-content-docs/version-1.3.2/current/user-guide/datasource-manual.md
index c62f0b0053..5bcc547edc 100644
--- a/i18n/zh-CN/docusaurus-plugin-content-docs/version-1.3.2/current/user-guide/datasource-manual.md
+++ b/i18n/zh-CN/docusaurus-plugin-content-docs/version-1.3.2/current/user-guide/datasource-manual.md
@@ -248,7 +248,8 @@ object TestMysqlClient {
//创建数据源
val dataSource = new DataSource();
- dataSource.setDataSourceName("for-mysql-test")
+ val dataSourceName = "for-mysql-test"
+ dataSource.setDataSourceName(dataSourceName)
dataSource.setDataSourceDesc("this is for mysql test")
dataSource.setCreateSystem(system)
dataSource.setDataSourceTypeId(1L)
@@ -294,14 +295,14 @@ object TestMysqlClient {
//使用示例
val metadataGetDatabasesAction: MetadataGetDatabasesAction = MetadataGetDatabasesAction.builder()
.setUser(user)
- .setDataSourceId(dataSourceId)
+ .setDataSourceName(dataSourceName)
.setSystem(system)
.build()
val metadataGetDatabasesResult: MetadataGetDatabasesResult = metaDataClient.getDatabases(metadataGetDatabasesAction)
val metadataGetTablesAction: MetadataGetTablesAction = MetadataGetTablesAction.builder()
.setUser(user)
- .setDataSourceId(dataSourceId)
+ .setDataSourceName(dataSourceName)
.setDatabase("linkis")
.setSystem(system)
.build()
@@ -309,7 +310,7 @@ object TestMysqlClient {
val metadataGetColumnsAction = MetadataGetColumnsAction.builder()
.setUser(user)
- .setDataSourceId(dataSourceId)
+ .setDataSourceName(dataSourceName)
.setDatabase("linkis")
.setSystem(system)
.setTable("linkis_datasource")
@@ -433,7 +434,8 @@ object TestHiveClient {
//创建数据源
val dataSource = new DataSource();
- dataSource.setDataSourceName("for-hive-test")
+ val dataSourceName = "for-hive-test"
+ dataSource.setDataSourceName(dataSourceName)
dataSource.setDataSourceDesc("this is for hive test")
dataSource.setCreateSystem(system)
dataSource.setDataSourceTypeId(4L)
@@ -473,14 +475,14 @@ object TestHiveClient {
//使用示例
val metadataGetDatabasesAction: MetadataGetDatabasesAction = MetadataGetDatabasesAction.builder()
.setUser(user)
- .setDataSourceId(dataSourceId)
+ .setDataSourceName(dataSourceName)
.setSystem(system)
.build()
val metadataGetDatabasesResult: MetadataGetDatabasesResult = metaDataClient.getDatabases(metadataGetDatabasesAction)
val metadataGetTablesAction: MetadataGetTablesAction = MetadataGetTablesAction.builder()
.setUser(user)
- .setDataSourceId(dataSourceId)
+ .setDataSourceName(dataSourceName)
.setDatabase("linkis_test_ind")
.setSystem(system)
.build()
@@ -490,7 +492,7 @@ object TestHiveClient {
val metadataGetColumnsAction = MetadataGetColumnsAction.builder()
.setUser(user)
- .setDataSourceId(dataSourceId)
+ .setDataSourceName(dataSourceName)
.setDatabase("linkis_test_ind")
.setSystem(system)
.setTable("test")
diff --git a/i18n/zh-CN/docusaurus-plugin-content-docs/version-1.3.2/user-guide/datasource-manual.md b/i18n/zh-CN/docusaurus-plugin-content-docs/version-1.3.2/user-guide/datasource-manual.md
index c62f0b0053..5bcc547edc 100644
--- a/i18n/zh-CN/docusaurus-plugin-content-docs/version-1.3.2/user-guide/datasource-manual.md
+++ b/i18n/zh-CN/docusaurus-plugin-content-docs/version-1.3.2/user-guide/datasource-manual.md
@@ -248,7 +248,8 @@ object TestMysqlClient {
//创建数据源
val dataSource = new DataSource();
- dataSource.setDataSourceName("for-mysql-test")
+ val dataSourceName = "for-mysql-test"
+ dataSource.setDataSourceName(dataSourceName)
dataSource.setDataSourceDesc("this is for mysql test")
dataSource.setCreateSystem(system)
dataSource.setDataSourceTypeId(1L)
@@ -294,14 +295,14 @@ object TestMysqlClient {
//使用示例
val metadataGetDatabasesAction: MetadataGetDatabasesAction = MetadataGetDatabasesAction.builder()
.setUser(user)
- .setDataSourceId(dataSourceId)
+ .setDataSourceName(dataSourceName)
.setSystem(system)
.build()
val metadataGetDatabasesResult: MetadataGetDatabasesResult = metaDataClient.getDatabases(metadataGetDatabasesAction)
val metadataGetTablesAction: MetadataGetTablesAction = MetadataGetTablesAction.builder()
.setUser(user)
- .setDataSourceId(dataSourceId)
+ .setDataSourceName(dataSourceName)
.setDatabase("linkis")
.setSystem(system)
.build()
@@ -309,7 +310,7 @@ object TestMysqlClient {
val metadataGetColumnsAction = MetadataGetColumnsAction.builder()
.setUser(user)
- .setDataSourceId(dataSourceId)
+ .setDataSourceName(dataSourceName)
.setDatabase("linkis")
.setSystem(system)
.setTable("linkis_datasource")
@@ -433,7 +434,8 @@ object TestHiveClient {
//创建数据源
val dataSource = new DataSource();
- dataSource.setDataSourceName("for-hive-test")
+ val dataSourceName = "for-hive-test"
+ dataSource.setDataSourceName(dataSourceName)
dataSource.setDataSourceDesc("this is for hive test")
dataSource.setCreateSystem(system)
dataSource.setDataSourceTypeId(4L)
@@ -473,14 +475,14 @@ object TestHiveClient {
//使用示例
val metadataGetDatabasesAction: MetadataGetDatabasesAction = MetadataGetDatabasesAction.builder()
.setUser(user)
- .setDataSourceId(dataSourceId)
+ .setDataSourceName(dataSourceName)
.setSystem(system)
.build()
val metadataGetDatabasesResult: MetadataGetDatabasesResult = metaDataClient.getDatabases(metadataGetDatabasesAction)
val metadataGetTablesAction: MetadataGetTablesAction = MetadataGetTablesAction.builder()
.setUser(user)
- .setDataSourceId(dataSourceId)
+ .setDataSourceName(dataSourceName)
.setDatabase("linkis_test_ind")
.setSystem(system)
.build()
@@ -490,7 +492,7 @@ object TestHiveClient {
val metadataGetColumnsAction = MetadataGetColumnsAction.builder()
.setUser(user)
- .setDataSourceId(dataSourceId)
+ .setDataSourceName(dataSourceName)
.setDatabase("linkis_test_ind")
.setSystem(system)
.setTable("test")
diff --git a/versioned_docs/version-1.3.2/user-guide/datasource-manual.md b/versioned_docs/version-1.3.2/user-guide/datasource-manual.md
index f6f2a393f4..676c11b99e 100644
--- a/versioned_docs/version-1.3.2/user-guide/datasource-manual.md
+++ b/versioned_docs/version-1.3.2/user-guide/datasource-manual.md
@@ -227,7 +227,8 @@ object TestMysqlClient {
//create data source
val dataSource = new DataSource();
- dataSource.setDataSourceName("for-mysql-test")
+ val dataSourceName = "for-mysql-test"
+ dataSource.setDataSourceName(dataSourceName)
dataSource.setDataSourceDesc("this is for mysql test")
dataSource.setCreateSystem(system)
dataSource.setDataSourceTypeId(1L)
@@ -273,14 +274,14 @@ object TestMysqlClient {
// use example
val metadataGetDatabasesAction: MetadataGetDatabasesAction = MetadataGetDatabasesAction.builder()
.setUser(user)
- .setDataSourceId(dataSourceId)
+ .setDataSourceName(dataSourceName)
.setSystem(system)
.build()
val metadataGetDatabasesResult: MetadataGetDatabasesResult = metaDataClient.getDatabases(metadataGetDatabasesAction)
val metadataGetTablesAction: MetadataGetTablesAction = MetadataGetTablesAction.builder()
.setUser(user)
- .setDataSourceId(dataSourceId)
+ .setDataSourceName(dataSourceName)
.setDatabase("linkis")
.setSystem(system)
.build()
@@ -288,7 +289,7 @@ object TestMysqlClient {
val metadataGetColumnsAction = MetadataGetColumnsAction.builder()
.setUser(user)
- .setDataSourceId(dataSourceId)
+ .setDataSourceName(dataSourceName)
.setDatabase("linkis")
.setSystem(system)
.setTable("linkis_datasource")
@@ -410,7 +411,8 @@ object TestHiveClient {
//create data source
val dataSource = new DataSource();
- dataSource.setDataSourceName("for-hive-test")
+ val dataSourceName = "for-hive-test"
+ dataSource.setDataSourceName(dataSourceName)
dataSource.setDataSourceDesc("this is for hive test")
dataSource.setCreateSystem(system)
dataSource.setDataSourceTypeId(4L)
@@ -450,14 +452,14 @@ object TestHiveClient {
// use example
val metadataGetDatabasesAction: MetadataGetDatabasesAction = MetadataGetDatabasesAction.builder()
.setUser(user)
- .setDataSourceId(dataSourceId)
+ .setDataSourceName(dataSourceName)
.setSystem(system)
.build()
val metadataGetDatabasesResult: MetadataGetDatabasesResult = metaDataClient.getDatabases(metadataGetDatabasesAction)
val metadataGetTablesAction: MetadataGetTablesAction = MetadataGetTablesAction.builder()
.setUser(user)
- .setDataSourceId(dataSourceId)
+ .setDataSourceName(dataSourceName)
.setDatabase("linkis_test_ind")
.setSystem(system)
.build()
@@ -467,7 +469,7 @@ object TestHiveClient {
val metadataGetColumnsAction = MetadataGetColumnsAction.builder()
.setUser(user)
- .setDataSourceId(dataSourceId)
+ .setDataSourceName(dataSourceName)
.setDatabase("linkis_test_ind")
.setSystem(system)
.setTable("test")
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@linkis.apache.org
For additional commands, e-mail: commits-help@linkis.apache.org