This is an automated email from the ASF dual-hosted git repository. haonan pushed a commit to branch fix_homepage_link in repository https://gitbox.apache.org/repos/asf/iotdb.git
commit 63111e70f69290212d26bf1153ac31fdf5a7ff58 Author: HTHou <[email protected]> AuthorDate: Thu Oct 8 11:00:17 2020 +0800 fix some website links --- docs/Community/Feedback.md | 10 +++++----- docs/Development/ContributeGuide.md | 18 +++++++++--------- docs/Development/VoteRelease.md | 14 +++++++------- docs/zh/Community/Community-Powered By.md | 2 +- docs/zh/Community/Feedback.md | 10 +++++----- docs/zh/Development/ContributeGuide.md | 21 ++++++++++++--------- docs/zh/Development/VoteRelease.md | 5 ++--- site/src/main/.vuepress/config.js | 6 +++--- 8 files changed, 44 insertions(+), 42 deletions(-) diff --git a/docs/Community/Feedback.md b/docs/Community/Feedback.md index bc67a05..7d466b2 100644 --- a/docs/Community/Feedback.md +++ b/docs/Community/Feedback.md @@ -23,19 +23,19 @@ As an Apache project, we are using mailing list, JIRA, and Github Issues to obtain the feedback of users. We also have a Twitter account. -* Mailing list: [email protected]. +* Mailing list: [[email protected]](mailto:[email protected]). * The mailing list is used for both user feedback and developer discussion. - * Follow method: Send an email to [email protected] with the email you want to + * Follow method: Send an email to [[email protected]](mailto:[email protected]) with the email you want to receive the email, the subject content is not limited, after receiving the reply, send a confirmation email to the confirmation address again (the confirmation address is longer, it is recommended gmail mailbox). -* JIRA issue: https://issues.apache.org/jira/projects/IOTDB/issues +* JIRA issue: [https://issues.apache.org/jira/projects/IOTDB/issues](https://issues.apache.org/jira/projects/IOTDB/issues) -* Github issue: https://github.com/apache/iotdb/issues +* Github issue: [https://github.com/apache/iotdb/issues](https://github.com/apache/iotdb/issues) -* Twitter: https://twitter.com/apacheiotdb +* Twitter: [https://twitter.com/apacheiotdb](https://twitter.com/apacheiotdb) * We look forward to you sharing the experience of using IoTDB: [Survey](https://github.com/apache/iotdb/issues/748) diff --git a/docs/Development/ContributeGuide.md b/docs/Development/ContributeGuide.md index 541d700..6e128d3 100644 --- a/docs/Development/ContributeGuide.md +++ b/docs/Development/ContributeGuide.md @@ -19,21 +19,21 @@ --> -# 1. work process +# Work process ## Main link -IoTDB official website：https://iotdb.apache.org/ +IoTDB official website：[https://iotdb.apache.org/](https://iotdb.apache.org/) -Code library：https://github.com/apache/iotdb/tree/master +Code library：[https://github.com/apache/iotdb/tree/master](https://github.com/apache/iotdb/tree/master) -Get started quickly：http://iotdb.apache.org/UserGuide/master/Get%20Started/QuickStart.html +Get started quickly：[http://iotdb.apache.org/UserGuide/master/Get%20Started/QuickStart.html](http://iotdb.apache.org/UserGuide/master/Get%20Started/QuickStart.html) ## Subscribe to mailing list The mailing list is where the Apache project conducts technical discussions and communication with users. Follow the mailing list to receive mail. -Mailing list address：[email protected] +Mailing list address：[[email protected]](mailto:[email protected]) Follow method: Send an email to [email protected] with the email you want to receive the email, the subject content is not limited, after receiving the reply, send a confirmation email to the confirmation address again (the confirmation address is longer, it is recommended gmail mailbox). @@ -49,7 +49,7 @@ Other mailing list: ## New features, bug feedback, improvements, and more -All features or bugs that you want IoTDB to do can be raised on Jira：https://issues.apache.org/jira/projects/IOTDB/issues +All features or bugs that you want IoTDB to do can be raised on [Jira] (https://issues.apache.org/jira/projects/IOTDB/issues) You can choose issue types: bug, improvement, new feature, etc. New issues will be automatically synchronized to the mailing list (notifications@), and subsequent discussions can be left on jira or on the mailing list. When the issue is resolved, close the issue. @@ -75,11 +75,11 @@ The content of all IoTDB official websites is in the docs of the project root di Correspondence between versions and branches on the official website: * In progress -> master -* major_version.x -> rel/major_version （如 0.9.x -> rel/0.9） +* major_version.x -> rel/major_version (Eg. 0.9.x -> rel/0.9) Precautions: -* Images in Markdown can be uploaded to https://github.com/thulab/iotdb/issues/543 for url +* Images in Markdown can be uploaded to [https://github.com/thulab/iotdb/issues/543](https://github.com/thulab/iotdb/issues/543) for url ## Contributing code @@ -95,7 +95,7 @@ You can go to jira to pick up the existing issue or create your own issue and ge * Make changes based on other people's reviews and continue to update until merged * close jira issue -## 2. IoTDB debugging method +# IoTDB debugging method Recommended Use Intellij idea. ```mvn clean package -DskipTests``` After putting ```antlr/target/generated-sources/antlr4``` and ```thrift/target/generated-sources/thrift``` marked as ```Source Root```。 diff --git a/docs/Development/VoteRelease.md b/docs/Development/VoteRelease.md index 2bef55e..63f33ec 100644 --- a/docs/Development/VoteRelease.md +++ b/docs/Development/VoteRelease.md @@ -21,21 +21,21 @@ # How to vote for a release -For non-Chinese users, please read https://cwiki.apache.org/confluence/display/IOTDB/Validating+a+staged+Release +For non-Chinese users, please read [How to vote for a release](https://cwiki.apache.org/confluence/display/IOTDB/Validating+a+staged+Release) -## Download everything under voting version / rc +## Download everything under voting version/rc -https://dist.apache.org/repos/dist/dev/iotdb/ +[https://dist.apache.org/repos/dist/dev/iotdb/](https://dist.apache.org/repos/dist/dev/iotdb/) ## Import the public key of the release manager -https://dist.apache.org/repos/dist/dev/iotdb/KEYS +[https://dist.apache.org/repos/dist/dev/iotdb/KEYS](https://dist.apache.org/repos/dist/dev/iotdb/KEYS) At the bottom is the public key of the Release Manager (RM) Install gpg2 -### the first method +### The first method ``` The beginning of the public key is this @@ -53,7 +53,7 @@ Download the public key gpg2 --receive-keys 10F3B3F8A1201B79AA43F2E00FC7F131CAA00430 (or 28662AC6) or (Designation keyserver) -gpg2 --keyserver p80.pool.sks-keyservers.net --recv-keys 10F3B3F8A1201B79AA43F2E00FC7F131CAA00430 (或 28662AC6) +gpg2 --keyserver p80.pool.sks-keyservers.net --recv-keys 10F3B3F8A1201B79AA43F2E00FC7F131CAA00430 (or 28662AC6) ``` ### The second method @@ -180,7 +180,7 @@ xxx ``` -## small tools +## Small tools * Print out lines containing certain characters (just look at the top output, you don't need to look at the bottom file) diff --git a/docs/zh/Community/Community-Powered By.md b/docs/zh/Community/Community-Powered By.md index 9db805c..e229147 100644 --- a/docs/zh/Community/Community-Powered By.md +++ b/docs/zh/Community/Community-Powered By.md @@ -38,7 +38,7 @@ 在产品描述中明确指出Apache IoTDB也是可以的，例如"该大数据产品是Apache IoTDB的一个子产品"。 ### 相关贡献或应用的公司和组织 -要将自己添加到列表中，请给[email protected]发送电子邮件，其中包含您的组织名称，URL，正在使用的IoTDB组件列表以及用例的简短描述。 +要将自己添加到列表中，请给[[email protected]](mailto:[email protected])发送电子邮件，其中包含您的组织名称，URL，正在使用的IoTDB组件列表以及用例的简短描述。 你也可以在[Github](https://github.com/apache/iotdb/issues/748) 留言。 diff --git a/docs/zh/Community/Feedback.md b/docs/zh/Community/Feedback.md index 9073c86..9b003b4 100644 --- a/docs/zh/Community/Feedback.md +++ b/docs/zh/Community/Feedback.md @@ -23,17 +23,17 @@ 作为Apache项目，我们使用邮件列表、JIRA和Github的issue模块来获取用户反馈。 -* 邮件列表: [email protected]. +* 邮件列表: [[email protected]](mailto:[email protected]). * 该列表同时用于用户反馈和开发者交流. - * 订阅方法：用想接收邮件的邮箱向 [email protected] 发一封邮件，主题内容不限，收到回复后， + * 订阅方法：用想接收邮件的邮箱向 [[email protected]](mailto:[email protected])发一封邮件，主题内容不限，收到回复后， 再次向确认地址发一封确认邮件（确认地址比较长，推荐qq邮箱）。 -* JIRA issue: https://issues.apache.org/jira/projects/IOTDB/issues +* JIRA issue: [https://issues.apache.org/jira/projects/IOTDB/issues](https://issues.apache.org/jira/projects/IOTDB/issues) -* Github issue: https://github.com/apache/iotdb/issues +* Github issue: [https://github.com/apache/iotdb/issues](https://github.com/apache/iotdb/issues) -* Twitter: https://twitter.com/apacheiotdb +* Twitter: [https://twitter.com/apacheiotdb](https://twitter.com/apacheiotdb) * 我们非常期待您分享您使用IoTDB的经验: [调研问卷](https://github.com/apache/iotdb/issues/748) diff --git a/docs/zh/Development/ContributeGuide.md b/docs/zh/Development/ContributeGuide.md index 6cdbd87..0dd81ce 100644 --- a/docs/zh/Development/ContributeGuide.md +++ b/docs/zh/Development/ContributeGuide.md @@ -19,32 +19,35 @@ --> -# 一、工作流程 +# 工作流程 ## 主要链接 -IoTDB 官网：https://iotdb.apache.org/ +IoTDB 官网：[https://iotdb.apache.org/](https://iotdb.apache.org/) -代码库：https://github.com/apache/iotdb/tree/master +代码库：[https://github.com/apache/iotdb/tree/master](https://github.com/apache/iotdb/tree/master) -快速上手：http://iotdb.apache.org/UserGuide/master/Get%20Started/QuickStart.html +快速上手：[http://iotdb.apache.org/UserGuide/master/Get%20Started/QuickStart.html](http://iotdb.apache.org/UserGuide/master/Get%20Started/QuickStart.html) -Jira 任务管理：https://issues.apache.org/jira/projects/IOTDB/issues +Jira 任务管理：[https://issues.apache.org/jira/projects/IOTDB/issues](https://issues.apache.org/jira/projects/IOTDB/issues) -Wiki 文档管理：https://cwiki.apache.org/confluence/display/IOTDB/Home +Wiki 文档管理：[https://cwiki.apache.org/confluence/display/IOTDB/Home](https://cwiki.apache.org/confluence/display/IOTDB/Home) ## 订阅邮件列表 邮件列表是 Apache 项目进行技术讨论和用户沟通的地方，订阅邮件列表就可以收到邮件了。 -邮件列表地址：[email protected] +邮件列表地址：[[email protected]](mailto:[email protected]) -订阅方法：用想接收邮件的邮箱向 [email protected] 发一封邮件，主题内容不限，收到回复后，再次向确认地址发一封确认邮件（确认地址比较长，推荐qq邮箱）。 +订阅方法：用想接收邮件的邮箱向 [[email protected]](mailto:[email protected]) 发一封邮件，主题内容不限，收到回复后，再次向确认地址发一封确认邮件（确认地址比较长，推荐qq邮箱）。 其他邮件列表: + * [email protected] (用于接收JIRA通知.) * 如果你只想接收个别感兴趣的JIRA通知，你不需要订阅这个列表。你只需要在JIRA issue页面上点击"开始关注这个issue" 或者在这个issue上做评论就行了。 + * [email protected] (任何代码改动都会通知到此处。该邮件列表邮件数量十分多，请注意。) + * [email protected] (任何代码审阅意见都会通知到此处。该邮件列表邮件数量十分多，请注意。) ## 新功能、Bug 反馈、改进等 @@ -95,7 +98,7 @@ IoTDB 所有官网上的内容都在项目根目录的 docs 中： * 根据其他人的审阅意见进行修改，继续更新，直到合并 * 关闭 jira issue -# 二、IoTDB 调试方式 +# IoTDB 调试方式 ## 导入代码 diff --git a/docs/zh/Development/VoteRelease.md b/docs/zh/Development/VoteRelease.md index 5250df3..5e39dba 100644 --- a/docs/zh/Development/VoteRelease.md +++ b/docs/zh/Development/VoteRelease.md @@ -21,15 +21,14 @@ # 给发布版本投票 -For non-Chinese users, please read https://cwiki.apache.org/confluence/display/IOTDB/Validating+a+staged+Release ## 下载投票的 版本/rc 下的所有内容 -https://dist.apache.org/repos/dist/dev/iotdb/ +[https://dist.apache.org/repos/dist/dev/iotdb/](https://dist.apache.org/repos/dist/dev/iotdb/) ## 导入发布经理的公钥 -https://dist.apache.org/repos/dist/dev/iotdb/KEYS +[https://dist.apache.org/repos/dist/dev/iotdb/KEYS](https://dist.apache.org/repos/dist/dev/iotdb/KEYS) 最下边有 Release Manager (RM) 的公钥 diff --git a/site/src/main/.vuepress/config.js b/site/src/main/.vuepress/config.js index 0dedaa7..07ab415 100644 --- a/site/src/main/.vuepress/config.js +++ b/site/src/main/.vuepress/config.js @@ -45,7 +45,7 @@ var config = { repo: 'https://github.com/apache/iotdb.git', // github 地址的链接名 - repoLabel: 'gitHub', + repoLabel: 'GitHub', logo: '/img/logo.png', @@ -99,10 +99,10 @@ var config = { { text: 'Development', items: [ - { text: 'How to vote', link: '/Development/VoteRelease'}, + { text: 'How to Vote', link: '/Development/VoteRelease'}, { text: 'How to Commit', link: '/Development/HowToCommit'}, { text: 'Become a Committer', link: '/Development/Committer'}, - { text: 'ContributeGuide', link: '/Development/ContributeGuide'}, + { text: 'Contribute Guide', link: '/Development/ContributeGuide'}, { text: 'Changelist of TsFile', link: '/Development/format-changelist'}, { text: 'Changelist of RPC', link: '/Development/rpc-changelist'}, ]
