Skip to content

Commit 2ea72ea

Browse files
docs: clarify documentation workflow
Signed-off-by: Muhammad Abdullah Shahid <108458621+abdollahShahid@users.noreply.github.com>
1 parent a3fa0e0 commit 2ea72ea

1 file changed

Lines changed: 8 additions & 8 deletions

File tree

docs/README.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,31 +1,31 @@
11
# Documentation
22

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.
44

55
# Website
66

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.
88

9-
# Docs and workaround with docs
9+
# Docs contribution workflow
1010

1111
PipeCD official site contains multiple versions of documentation, all placed under the `/docs/content/en` directory, which are:
1212
- `/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.
1414

15-
Here are the flow of docs contribution regard some known scenarios:
15+
Use the following workflow for common documentation contribution scenarios:
1616
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.
1818
2. Update docs for not yet released features or changes:
1919
In such case, update the docs under `/docs-dev` is enough.
2020
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.
2222

2323
If you find any issues related to the docs, we're happy to accept your help.
2424

2525
# How to run website locally
2626

2727
## Prerequisite
28-
- [Hugo 0.92.1+extended](https://gohugo.io/)
28+
- [Hugo Extended 0.92.1+](https://gohugo.io/)
2929

3030
## Commands
3131
Run `make run/site` at the root directory of the repository and then access http://localhost:1313

0 commit comments

Comments
 (0)