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/incubator-linkis-website.git
The following commit(s) were added to refs/heads/dev by this push:
new 98fd89ed58 add path and English docs specification (#432)
98fd89ed58 is described below
commit 98fd89ed58a35a67266aa9f6f782f19f2ad42134
Author: Beacontownfc <[email protected]>
AuthorDate: Mon Jul 18 19:50:44 2022 +0800
add path and English docs specification (#432)
---
community/how-to-contribute-to-website.md | 6 ++++++
.../current/how-to-contribute-to-website.md | 6 ++++++
2 files changed, 12 insertions(+)
diff --git a/community/how-to-contribute-to-website.md
b/community/how-to-contribute-to-website.md
index 41c7b3e9fb..ae4b91b805 100644
--- a/community/how-to-contribute-to-website.md
+++ b/community/how-to-contribute-to-website.md
@@ -157,6 +157,12 @@ Visit the page https://linkis.apache.org/user
Company logo Located in `static/home/user`, and the picture size must be 176 ×
88.
+### 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`.
+
+### 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.
+
## 4 New documents
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 11d537f1e7..700aed257d 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
@@ -157,6 +157,12 @@ Visit the page https://linkis.apache.org/zh-CN/user
公司的logo位于 `static/home/user`, 且图片的大小必须是 176 × 88.
+### 3.10 路径规范
+如果希望想从一个markdown文档链接到另外一个文档, 最好使用绝对路径. 例如, 如果希望链接到 `quick_deploy.md`这个文档,
路径应写成 `/docs/deployment/quick_deploy.md`。
+
+### 英文文档标题规范
+英文文档侧边栏除介词外的所有词首字母使用大写, 同时英文markdown中的标题的第一个词首字母应大写，其他词首字母小写。
+
## 4 新增文档
md文档建议通过访问官网查看,通过github查看md文档存在图片等静态资源无法正确显示问题
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
