This is an automated email from the ASF dual-hosted git repository.
haonan pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/iotdb-docs.git
The following commit(s) were added to refs/heads/main by this push:
new 703b079 docs(HowtoContributeCode): update (#22)
703b079 is described below
commit 703b07905d9576a010532a8c1e50615153f99659
Author: CritasWang <[email protected]>
AuthorDate: Thu Jul 27 15:33:30 2023 +0800
docs(HowtoContributeCode): update (#22)
---
src/Development/ContributeGuide.md | 26 +++++++++++++-------------
src/Development/HowtoContributeCode.md | 14 +++++++-------
src/zh/Development/ContributeGuide.md | 26 +++++++++++++-------------
src/zh/Development/HowtoContributeCode.md | 16 ++++++++--------
4 files changed, 41 insertions(+), 41 deletions(-)
diff --git a/src/Development/ContributeGuide.md
b/src/Development/ContributeGuide.md
index 72416c4..16b9a6f 100644
--- a/src/Development/ContributeGuide.md
+++ b/src/Development/ContributeGuide.md
@@ -29,6 +29,8 @@ Code library：https://github.com/apache/iotdb
Code library for go language: https://github.com/apache/iotdb-client-go
+Docs library：https://github.com/apache/iotdb-docs
+
Library for resources (project's documents, compiler, etc):
https://github.com/apache/iotdb-bin-resources
Get started
quickly：http://iotdb.apache.org/UserGuide/Master/QuickStart/QuickStart.html
@@ -74,25 +76,23 @@ You can choose issue types: bug, improvement, new feature,
etc. New issues will
## Contributing documents
-The content of all IoTDB official websites is in the docs of the project root
directory:
+The content of all IoTDB official websites is in the src directory of the
https://github.com/apache/iotdb-docs:
-* docs/SystemDesign: System Design Document-English Version
-* docs/zh/SystemDesign: System Design Document-Chinese Version
-* docs/UserGuide: User Guide English Version
-* docs/zh/UserGuide: User Guide Chinese Version
-* docs/Community: community English Version
-* docs/zh/Community: community Chinese Version
-* docs/Development: Development Guide English Version
-* docs/zh/Development: Development Guide Chinese Version
+* src/UserGuide: User Guide English Version
+* src/zh/UserGuide: User Guide Chinese Version
+* src/Community: community English Version
+* src/zh/Community: community Chinese Version
+* src/Development: Development Guide English Version
+* src/zh/Development: Development Guide Chinese Version
-Correspondence between versions and branches on the official website:
+Correspondence between versions and directory:
-* In progress -> master
-* major_version.x -> rel/major_version （eg 0.9.x -> rel/0.9）
+* In progress -> src/UserGuide/Master, src/zh/UserGuide/Master
+* major_version.x -> rel/major_version （eg 1.1.x -> V1.1.x）
Precautions:
-* Images in Markdown can be uploaded to
https://github.com/apache/iotdb-bin-resources for url
+* Images in Markdown can be uploaded to .vuepress/public/img and referenced
directly in Markdown
* Do not use special Unicode chars, e.g., U+FF1A
* Do not use the character of dollar (as we will use Latex to generate pdf
files)
diff --git a/src/Development/HowtoContributeCode.md
b/src/Development/HowtoContributeCode.md
index 75abd0a..48b38d0 100644
--- a/src/Development/HowtoContributeCode.md
+++ b/src/Development/HowtoContributeCode.md
@@ -42,7 +42,7 @@ Issue type : New Feature
1.Submit the user manual and the pr for code changes.
-A user manual is mainly for helping users understand how the functions work
and how to use them. It is recommended to contain scenario and background,
configuration, interface description and examples. The user manual of the
official website is placed in the docs/UserGuide folder of apache/iotdb
repository. To update the user manual directory, including adding, deleting
documents and renaming documents, you need to make corresponding changes in the
file(path:site/src/main/.vuepress/confi [...]
+A user manual is mainly for helping users understand how the functions work
and how to use them. It is recommended to contain scenario and background,
configuration, interface description and examples. The user manual of the
official website is placed in the src/UserGuide folder of apache/iotdb-docs
repository. To update the user manual directory, including adding, deleting
documents and renaming documents, you need to make corresponding changes in the
file(path:src/.vuepress/sidebar) in [...]
2.Submit UT (unit test) or IT (integration test).
@@ -80,7 +80,7 @@ a.Configuration file:
iodtb-core/datanode/src/assembly/resources/conf/iotdb-data
b. Codes: IoTDBDescriptor, IoTDBConfig
-c. Documentation: docs/UserGuide/Reference/DataNode-Config-Manual.md
+c. Documentation:
apache/iotdb-docs/src/UserGuide/{version}/Reference/DataNode-Config-Manual.md
3.To modify configuration parameters in IT and UT, you need to modify them in
the method annotated by @before and reset them in the method annotated by
@after. In this way, you can avoid impact on other tests. The parameters of the
compaction module are placed in the CompactionConfigRestorer file.
@@ -134,9 +134,9 @@ Choose squash merge. You can choose rebase only when the
author has only one com
Close the corresponding issue in JIRA, and mark the repaired or completed
version. Note that solving or closing an issue requires adding a pr or
description to the issue, so that changes can be tracked via the issue.
## How to Prepare User Manual and Design Document
-User manual and other documentation on the official website are maintained in
the apache/iotdb repository.
+User manual and other documentation on the official website are maintained in
the apache/iotdb-docs repository.
-The index items of each page of the official website are maintained in the
file "site/src/main/.vuepress/config.js" of the master branch, while the
specific content of the user manual is maintained in the branch of the
corresponding version (for example, user manual for 0.12 is in rel/0.12).
+The index items of each page of the official website are maintained in the
file "src/.vuepress/sidebar" of the main branch, while the specific content of
the user manual is maintained in the directory of the corresponding version
(for example, user manual for 1.1 is in src/UserGuide/V1.1.x).
User manual
@@ -151,10 +151,10 @@ It is recommended that the design document contains
background, design goals, id
### Modifying User Manual
Other than modifying different files, the process is the same as contributing
codes.
-The English user manual is placed in the docs/UserGuide folder.
+The English user manual is placed in the src/UserGuide folder.
-To update the user manual directory, including adding, deleting documents and
renaming documents, you need to make corresponding changes in the
file(path:site/src/main/.vuepress/config.js) in the master branch.
+To update the user manual directory, including adding, deleting documents and
renaming documents, you need to make corresponding changes in the
file(path:src/.vuepress/sidebar) in the main branch.
### Modifying the Top Navigation Bar of the Official Website
-Search for nav in the file(path:site/src/main/.vuepress/config.js), and make
corresponding modifications by referencing the existing code, then submit a PR
and wait for merging. Documents to be added can be placed in the docs folder.
\ No newline at end of file
+Search for nav in the file(path:src/.vuepress/navbar/en.ts), and make
corresponding modifications by referencing the existing code, then submit a PR
and wait for merging. Documents to be added can be placed in the src folder.
\ No newline at end of file
diff --git a/src/zh/Development/ContributeGuide.md
b/src/zh/Development/ContributeGuide.md
index 0e858bf..adaac2e 100644
--- a/src/zh/Development/ContributeGuide.md
+++ b/src/zh/Development/ContributeGuide.md
@@ -29,6 +29,8 @@ IoTDB 官网：https://iotdb.apache.org/
Go语言的代码库：https://github.com/apache/iotdb-client-go
+文档库：https://github.com/apache/iotdb-docs
+
资源库（包含项目文件等）：https://github.com/apache/iotdb-bin-resources
快速上手：https://iotdb.apache.org/zh/UserGuide/V1.1.x/QuickStart/QuickStart.html
@@ -71,25 +73,23 @@ Slack:
https://apacheiotdb.slack.com/join/shared_invite/zt-qvso1nj8-7715TpySZtZq
## 贡献文档
-IoTDB 所有官网上的内容都在项目根目录的 docs 中：
+IoTDB 所有官网上的内容都在 https://github.com/apache/iotdb-docs 的 src 中：
-* docs/SystemDesign: 系统设计文档-英文版
-* docs/zh/SystemDesign: 系统设计文档-中文版
-* docs/UserGuide: 用户手册-英文版
-* docs/zh/UserGuide: 用户手册-中文版
-* docs/Community: 社区-英文版
-* docs/zh/Community: 社区-中文版
-* docs/Development: 开发指南-英文版
-* docs/zh/Development: 开发指南-中文版
+* src/UserGuide: 用户手册-英文版
+* src/zh/UserGuide: 用户手册-中文版
+* src/Community: 社区-英文版
+* src/zh/Community: 社区-中文版
+* src/Development: 开发指南-英文版
+* src/zh/Development: 开发指南-中文版
-官网上的版本和分支的对应关系：
+文档版本和文件夹的对应关系：
-* In progress -> master
-* major_version.x -> rel/major_version （如 0.9.x -> rel/0.9）
+* In progress -> src/UserGuide/Master, src/zh/UserGuide/Master
+* major_version.x -> src/UserGuide/major_version,
src/zh/UserGuide/major_version （如 1.1.x -> V1.1.x）
注意事项：
-* Markdown 中的图片可上传至 https://github.com/apache/iotdb-bin-resources 获得 url
+* Markdown 中的图片可上传至 .vuepress/public/img 文件夹下，引用时使用相对路径即可。
## 代码格式化
diff --git a/src/zh/Development/HowtoContributeCode.md
b/src/zh/Development/HowtoContributeCode.md
index 490abb9..a07ccef 100644
--- a/src/zh/Development/HowtoContributeCode.md
+++ b/src/zh/Development/HowtoContributeCode.md
@@ -42,8 +42,8 @@ Issue 类型：New Feature
1.提交中英文版本的用户手册和代码修改的 pr。
-用户手册主要描述功能定义和使用方式，以便用户使用。用户手册建议包括：场景描述，配置方法，接口功能描述，使用示例。官网的用户手册内容放置在
apache/iotdb 仓库根目录下，英文版放在 docs/UserGuide ，中文版放在 docs/zh/UserGuide 。
-如果需要更新用户手册，包括新增或删除文档和修改文档名，需要在 master 分支的site/src/main/.vuepress/config.js
中做相应修改。
+用户手册主要描述功能定义和使用方式，以便用户使用。用户手册建议包括：场景描述，配置方法，接口功能描述，使用示例。官网的用户手册内容放置在
apache/iotdb-docs 仓库 src 目录下，英文版放在 src/UserGuide ，中文版放在 src/zh/UserGuide 。
+如果需要更新用户手册，包括新增或删除文档和修改文档名，需要在 main 分支的 src/.vuepress/sidebar 中做相应修改。
2.提交单元测试UT或集成测试IT
@@ -77,7 +77,7 @@ iotdb-datanode.properties 和 IoTDBConfig 默认值需要保持一致。
如果需要对配置参数进行改动。以下文件需要同时修改：
1.
配置文件：iotdb-core/datanode/src/assembly/resources/conf/iotdb-datanode.properties
2. 代码：IoTDBDescriptor、IoTDBConfig
- 3.
文档：docs/UserGuide/Reference/DataNode-Config-Manual.md、docs/zh/UserGuide/Reference/DataNode-Config-Manual.md
+ 3.
文档：apache/iotdb-docs/src/UserGuide/{version}/Reference/DataNode-Config-Manual.md、apache/iotdb-docs/src/zh/UserGuide/{version}/Reference/DataNode-Config-Manual.md
如果你想要在 IT 和 UT 文件中对配置参数进行修改，你需要在 @Before 修饰的方法里修改，并且在 @After
修饰的方法里重置，来避免对其他测试的影响。合并模块的参数统一放在CompactionConfigRestorer 文件里。
@@ -130,9 +130,9 @@ Jira 标签
到 JIRA 上关闭对应的 issue，标记修复或完成的版本【注意，解决或关闭 issue 都需要对 issue 添加 pr 或描述，通过 issue
要能够追踪这个任务的变动】。
## 如何写用户手册和设计文档
-官网的用户手册和其他文档都在 apache/iotdb 仓库中进行维护。
+官网的用户手册和其他文档都在 apache/iotdb-docs 仓库中进行维护。
-官网各个页面的索引项是在 master 分支的 site/src/main/.vuepress/config.js
文件维护的，用户手册的具体内容是在各个版本的分支维护的，如 0.12 版本的用户手册文档在 rel/0.12 中。
+官网各个页面的索引项是在 main 分支的 src/.vuepress/sidebar 文件夹维护的，用户手册的具体内容是在各个版本文件夹维护的，如 1.1
版本的用户手册文档在 src/UserGuide/V1.1.x 中。
用户手册
@@ -146,9 +146,9 @@ Jira 标签
### 如何修改用户手册
贡献用户手册和贡献代码的流程是一样的，只是修改的文件不同。
-用户手册的英文版放在 docs/UserGuide , 中文版放在 docs/zh/UserGuide 下。
-如果需要更新 {master} 或 {rel/*} 分支的用户手册目录，包括新增或删除md文档、修改md文档名，需要在 master
分支的site/src/main/.vuepress/config.js 中做相应修改。
+用户手册的英文版放在 src/UserGuide , 中文版放在 src/zh/UserGuide 下。
+如果需要更新用户手册目录，包括新增或删除md文档、修改md文档名，需要在 main 分支的 src/.vuepress/sidebar 中做相应修改。
### 如何修改官网顶部导航栏
-在 site/src/main/.vuepress/config.js 中搜索 nav
（应有中英文两个地方），仿照现有的代码做相应修改。之后提交PR等待合并。需要新增的文档可以放进 docs 和 docs/zh 文件夹下。
\ No newline at end of file
+在 src/.vuepress/navbar/en.ts,src/.vuepress/navbar/zh.ts
中（应有中英文两个地方），仿照现有的代码做相应修改。之后提交PR等待合并。需要新增的文档可以放进 src 和 src/zh 文件夹下。
\ No newline at end of file
