update docs to make mkdocs page #469
Conversation
docs/Contribute-to-documentation.md
Outdated
|
|
||
| ## How to contribute to the docs | ||
| There are many wats to contribute: | ||
| - Edit, rate, or file an issue or question directly on the site by using the links available on the right-side menu on every pare at docs.nebula.com. |
| @@ -1,4 +1,3 @@ | |||
| ## Get Started | |||
There was a problem hiding this comment.
I find the other .md file's name is upper case . Please rename get-started.md to Get-started.md thanks
There was a problem hiding this comment.
If the filename will be showed in the address bar of the browser, lower case might be more suitable, except some special ones, like nGQL.
| @@ -22,7 +21,11 @@ docker --version | |||
|
|
|||
| If `docker` is not found, please see [here](https://docs.docker.com/install/) for more information to install docker. | |||
|
|
|||
| After that, using `docker pull vesoft/nebula-graph:latest` to get `nebula` image and `docker images` that can display images status. | |||
| After that, using | |||
| ``` | |||
There was a problem hiding this comment.
Using block is better. :) I like it .
| @@ -0,0 +1,101 @@ | |||
| --- | |||
There was a problem hiding this comment.
Is this the header? I think it's a good habit.
Would you mind adding it to other documents? thanks
docs/Contribute-to-documentation.md
Outdated
|
|
||
|
|
||
| ## How to contribute to the docs | ||
| There are many wats to contribute: |
There was a problem hiding this comment.
it's a typo, it should ways, thank you
docs/Contribute-to-documentation.md
Outdated
|
|
||
| --- | ||
| ## Contribute to documentation | ||
| Contributing to the Nebula documentation can be a rewarding experience. When you offer feedback, questions, edits, or new content, you help us, the projects you work on, and the larger Nebula community. |
There was a problem hiding this comment.
When you offer feedback, questions, edits, or new content, you help us, the projects you work on, and the larger Nebula community.
This should be divided into two.
When you offer feedbacks, questions, edits, or new contents, you are helping us.
Besides, what the projects you work on, and the larger Nebula community. is saying?
There was a problem hiding this comment.
Means users' feedback can help us improve our Nebula community. Deleted that sentence and add
We welcome your participation to help make the documentation better!
| @@ -0,0 +1,16 @@ | |||
|
|
|||
| --- | |||
| ## Contribute to documentation | |||
There was a problem hiding this comment.
The filename of docs should be all lower case.
| @@ -1,4 +1,3 @@ | |||
| ## Get Started | |||
There was a problem hiding this comment.
If the filename will be showed in the address bar of the browser, lower case might be more suitable, except some special ones, like nGQL.
|
Jenkins, go! |
|
Unit testing passed. |
* update docs to make mkdocs page * fix Contribute-to-documentation.md info * fix layout in Contribute-to-documentation.md * fix typos * add nGQL-tutorial
I've added three new files in 'docs':
index.md
Contribute-to-documentation.md
Developer-documentation-style-guide.md
changed some layout in get-started.md
After the doc is done, I will make a doc site based on that.