diff --git a/docs/content/en/docs-dev/contribution-guidelines/development.md b/docs/content/en/docs-dev/contribution-guidelines/development.md index 51afdb4471..ca31189728 100644 --- a/docs/content/en/docs-dev/contribution-guidelines/development.md +++ b/docs/content/en/docs-dev/contribution-guidelines/development.md @@ -36,3 +36,25 @@ For more information, you might want to read the [installation notes of `bazelis - `make site`: runs PipeCD site (https://pipecd.dev) locally (requires [hugo](https://github.com/gohugoio/hugo) with `_extended` version `0.88.1` or later to be installed). **NOTE**: The first time of running a bazel command will take some minutes because bazel needs to download all required dependencies. From the second time it will be very fast. + +## Docs and workaround with docs + +PipeCD official site contains multiple versions of documentation, all placed under the `/docs/content/en` directory, which are: +- `/docs`: stable version docs, usually synced with the latest released version docs. +- `/docs-dev`: experimental version docs, contains docs for not yet released features or changes. +- `/docs-v0.x.x`: contains docs for specified version family (a version family is all versions which in the same major release). + +Basically, we have two simple rules: +- Do not touch to the `/docs` content directly. +- Keep stable docs version synced with the latest released docs version. + +Here are the flow of docs contribution regard some known scenarios: +1. Update docs that are related to a specified version (which is not the latest released version): +In such case, update the docs under `/docs-v0.x.x` is enough. +2. Update docs for not yet released features or changes: +In such case, update the docs under `/docs-dev` is enough. +3. Update docs that are related to the latest released docs version: +- 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. +- Use `make sync-stable-docs` command to sync the latest released version docs under `/docs-v0.x.x` to `/docs` + +If you find any issues related to the docs, we're happy to accept your help. diff --git a/docs/content/en/docs-v0.21.x/contribution-guidelines/development.md b/docs/content/en/docs-v0.21.x/contribution-guidelines/development.md index 51afdb4471..ca31189728 100644 --- a/docs/content/en/docs-v0.21.x/contribution-guidelines/development.md +++ b/docs/content/en/docs-v0.21.x/contribution-guidelines/development.md @@ -36,3 +36,25 @@ For more information, you might want to read the [installation notes of `bazelis - `make site`: runs PipeCD site (https://pipecd.dev) locally (requires [hugo](https://github.com/gohugoio/hugo) with `_extended` version `0.88.1` or later to be installed). **NOTE**: The first time of running a bazel command will take some minutes because bazel needs to download all required dependencies. From the second time it will be very fast. + +## Docs and workaround with docs + +PipeCD official site contains multiple versions of documentation, all placed under the `/docs/content/en` directory, which are: +- `/docs`: stable version docs, usually synced with the latest released version docs. +- `/docs-dev`: experimental version docs, contains docs for not yet released features or changes. +- `/docs-v0.x.x`: contains docs for specified version family (a version family is all versions which in the same major release). + +Basically, we have two simple rules: +- Do not touch to the `/docs` content directly. +- Keep stable docs version synced with the latest released docs version. + +Here are the flow of docs contribution regard some known scenarios: +1. Update docs that are related to a specified version (which is not the latest released version): +In such case, update the docs under `/docs-v0.x.x` is enough. +2. Update docs for not yet released features or changes: +In such case, update the docs under `/docs-dev` is enough. +3. Update docs that are related to the latest released docs version: +- 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. +- Use `make sync-stable-docs` command to sync the latest released version docs under `/docs-v0.x.x` to `/docs` + +If you find any issues related to the docs, we're happy to accept your help. diff --git a/docs/content/en/docs/contribution-guidelines/development.md b/docs/content/en/docs/contribution-guidelines/development.md index 51afdb4471..ca31189728 100644 --- a/docs/content/en/docs/contribution-guidelines/development.md +++ b/docs/content/en/docs/contribution-guidelines/development.md @@ -36,3 +36,25 @@ For more information, you might want to read the [installation notes of `bazelis - `make site`: runs PipeCD site (https://pipecd.dev) locally (requires [hugo](https://github.com/gohugoio/hugo) with `_extended` version `0.88.1` or later to be installed). **NOTE**: The first time of running a bazel command will take some minutes because bazel needs to download all required dependencies. From the second time it will be very fast. + +## Docs and workaround with docs + +PipeCD official site contains multiple versions of documentation, all placed under the `/docs/content/en` directory, which are: +- `/docs`: stable version docs, usually synced with the latest released version docs. +- `/docs-dev`: experimental version docs, contains docs for not yet released features or changes. +- `/docs-v0.x.x`: contains docs for specified version family (a version family is all versions which in the same major release). + +Basically, we have two simple rules: +- Do not touch to the `/docs` content directly. +- Keep stable docs version synced with the latest released docs version. + +Here are the flow of docs contribution regard some known scenarios: +1. Update docs that are related to a specified version (which is not the latest released version): +In such case, update the docs under `/docs-v0.x.x` is enough. +2. Update docs for not yet released features or changes: +In such case, update the docs under `/docs-dev` is enough. +3. Update docs that are related to the latest released docs version: +- 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. +- Use `make sync-stable-docs` command to sync the latest released version docs under `/docs-v0.x.x` to `/docs` + +If you find any issues related to the docs, we're happy to accept your help.