Skip to content

Commit

Permalink
Redirect /docs/ to /docs-{latest}/ (#4495)
Browse files Browse the repository at this point in the history
* Redirect /docs/ to /docs-{latest}/

Signed-off-by: Kenta Kozuka <[email protected]>

* Fix use local path

Signed-off-by: Kenta Kozuka <[email protected]>

---------

Signed-off-by: Kenta Kozuka <[email protected]>
  • Loading branch information
kentakozuka authored Jul 15, 2023
1 parent 208640f commit 28bb15c
Show file tree
Hide file tree
Showing 74 changed files with 15 additions and 6,370 deletions.
14 changes: 0 additions & 14 deletions .github/workflows/gen.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -21,17 +21,3 @@ jobs:
- name: Validate
shell: bash
run: test -z "$(git status --porcelain)"

docs:
runs-on: ubuntu-latest
steps:
- name: Checkout repository
uses: actions/checkout@v3
- name: Generate stable docs
run: make gen/stable-docs
- name: Show Git status
shell: bash
run: git status
- name: Validate
shell: bash
run: test -z "$(git status --porcelain)"
4 changes: 0 additions & 4 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -181,10 +181,6 @@ gen/code:
# NOTE: Specify a specific version temporally until the next release.
docker run --rm -v ${PWD}:/repo -it --entrypoint ./tool/codegen/codegen.sh ghcr.io/pipe-cd/codegen@sha256:fc3db505ef8dbf287b90aafed8c28246d2cca06bda2b43893a3059719fe9fff4 /repo #v0.44.0-38-g7229285

.PHONY: gen/stable-docs
gen/stable-docs:
./hack/gen-stable-docs.sh $(version)

.PHONY: gen/test-tls
gen/test-tls:
openssl req -x509 -nodes -days 3650 -newkey rsa:2048 \
Expand Down
8 changes: 1 addition & 7 deletions docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,22 +9,16 @@ The PipeCD documentation website is built with [hugo](https://gohugo.io/) and pu
# 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 gen/stable-docs` command to sync the latest released version docs under `/docs-v0.x.x` to `/docs`
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.

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

Expand Down
2 changes: 1 addition & 1 deletion docs/content/en/_index.html
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@
<a class="btn btn-lg btn-primary mr-3 mb-4" target="_blank" href="https://play.pipecd.dev?project=play">
Live Demo <i class="fas fa-arrow-alt-circle-right ml-2"></i>
</a>
<a class="btn btn-lg btn-primary mr-3 mb-4" href="{{< relref "/docs/quickstart/" >}}">
<a class="btn btn-lg btn-primary mr-3 mb-4" href="https://pipecd.dev/docs/quickstart/">
Quick Start <i class="fas fa-arrow-alt-circle-right ml-2"></i>
</a>
<a class="btn btn-lg btn-secondary mr-3 mb-4" target="_blank" href="https://github.com/pipe-cd/pipecd">
Expand Down
8 changes: 0 additions & 8 deletions docs/content/en/docs/_index.md

This file was deleted.

75 changes: 0 additions & 75 deletions docs/content/en/docs/concepts/_index.md

This file was deleted.

7 changes: 0 additions & 7 deletions docs/content/en/docs/contribution-guidelines/_index.md

This file was deleted.

This file was deleted.

9 changes: 0 additions & 9 deletions docs/content/en/docs/contribution-guidelines/contributing.md

This file was deleted.

91 changes: 0 additions & 91 deletions docs/content/en/docs/examples/_index.md

This file was deleted.

Loading

0 comments on commit 28bb15c

Please sign in to comment.