jixuan1989
/
IoTDB
mirror of https://github.com/apache/iotdb
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

[IOTDB-133] Fix mistaken links in documents 

There are still some other mistaken links.
This commit is contained in:
zhutianci 2019-07-12 20:38:21 +08:00
parent 73f4936520
commit a7815e3fd0
1 changed files with 8 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
docs/Development.md
View File

@ -84,17 +84,17 @@ Changes to IoTDB source codes are made through Github pull request. Anyone can r
To propose a change to release documentation (that is, docs that appear under <https://iotdb.apache.org/#/Documents>), edit the Markdown source files in Iotdb’s docs/ directory(`documentation-EN` branch). The process to propose a doc change is otherwise the same as the process for proposing code changes below.
Whenever updating **User Guide** documents, remember to update "0-Content.md" in the same time. Here are two brief examples to show how to add new documents or how to modify existing documents:
Whenever updating **User Guide** documents, remember to update `0-Content.md` in the same time. Here are two brief examples to show how to add new documents or how to modify existing documents:
1. Suppose we have "chapter 1:Overview" already, and want to add a new document "A.md" in chapter 1.
1. Suppose we have "chapter 1:Overview" already, and want to add a new document `A.md` in chapter 1.
Then,
* Step 1: add document named "5-A.md" in folder "1-Overview", since it is the fifth section in this chapter;
* Step 2: modify "0-Content.md" file by adding "* 5-A.md" in the list of "# Chapter 1: Overview".
* Step 1: add document named `5-A.md` in folder "1-Overview", since it is the fifth section in this chapter;
* Step 2: modify `0-Content.md` file by adding `* 5-A.md` in the list of "# Chapter 1: Overview".
2. Suppose we want to create a new chapter "chapter7: RoadMap", and want to add a new document "B.md" in chapter 7.
2. Suppose we want to create a new chapter "chapter7: RoadMap", and want to add a new document `B.md` in chapter 7.
Then,
* Step 1: create a new folder named "7-RoadMap", and add document named "1-B.md" in folder "7-RoadMap";
* Step 2: modify "0-Content.md" file by adding "# Chapter 7: RoadMap" in the end, and adding "* 1-B.md" in the list of this new chapter.
* Step 1: create a new folder named "7-RoadMap", and add document named `1-B.md` in folder "7-RoadMap";
* Step 2: modify `0-Content.md` file by adding "# Chapter 7: RoadMap" in the end, and adding `* 1-B.md` in the list of this new chapter.
### Contributing Bug Reports
@ -117,7 +117,7 @@ Note that, data correctness/loss bugs are our first priority to solve. Please ma
```
$ git clone git@github.com:apache/incubator-iotdb.git
```
Following README.md to test, run or build IoTDB.
Following `README.md` to test, run or build IoTDB.
#### JIRA