|
1 | 1 | # Documentation |
2 | 2 |
|
3 | | -The source files for the documentation is placing in [content](https://github.com/pipe-cd/pipecd/tree/master/docs/content) directory. |
| 3 | +The source files for the PipeCD documentation are placed in the [docs/content](https://github.com/pipe-cd/pipecd/tree/master/docs/content) directory. |
4 | 4 |
|
5 | 5 | # Website |
6 | 6 |
|
7 | | -The PipeCD documentation website is built with [hugo](https://gohugo.io/) and published at https://pipecd.dev |
| 7 | +The PipeCD documentation website is built with [Hugo](https://gohugo.io/) and published at https://pipecd.dev. |
8 | 8 |
|
9 | | -# Docs and workaround with docs |
| 9 | +# Docs contribution workflow |
10 | 10 |
|
11 | 11 | PipeCD official site contains multiple versions of documentation, all placed under the `/docs/content/en` directory, which are: |
12 | 12 | - `/docs-dev`: experimental version docs, contains docs for not yet released features or changes. |
13 | | -- `/docs-v0.x.x`: contains docs for specified version family (a version family is all versions which in the same major release). |
| 13 | +- `/docs-vX.Y.x`: contains docs for a specific released version family. |
14 | 14 |
|
15 | | -Here are the flow of docs contribution regard some known scenarios: |
| 15 | +Use the following workflow for common documentation contribution scenarios: |
16 | 16 | 1. Update docs that are related to a specified version (which is not the latest released version): |
17 | | -In such case, update the docs under `/docs-v0.x.x` is enough. |
| 17 | +In such case, update the docs under `/docs-vX.Y.x` is enough. |
18 | 18 | 2. Update docs for not yet released features or changes: |
19 | 19 | In such case, update the docs under `/docs-dev` is enough. |
20 | 20 | 3. Update docs that are related to the latest released docs version: |
21 | | -Change the docs' content that fixes the issue under `/docs-dev` and `/docs-v0.x.x`, they share the same file structure so you should find the right files in both directories. |
| 21 | +Change the docs' content that fixes the issue under `/docs-dev` and `/docs-vX.Y.x`; they share the same file structure, so you should find the right files in both directories. |
22 | 22 |
|
23 | 23 | If you find any issues related to the docs, we're happy to accept your help. |
24 | 24 |
|
25 | 25 | # How to run website locally |
26 | 26 |
|
27 | 27 | ## Prerequisite |
28 | | -- [Hugo 0.92.1+extended](https://gohugo.io/) |
| 28 | +- [Hugo Extended 0.92.1+](https://gohugo.io/) |
29 | 29 |
|
30 | 30 | ## Commands |
31 | 31 | Run `make run/site` at the root directory of the repository and then access http://localhost:1313 |
0 commit comments