Skip to content

README.md

Latest commit

 

History

History
43 lines (27 loc) · 1.78 KB

README.md

File metadata and controls

43 lines (27 loc) · 1.78 KB
Raw

Documentation

The source files for the documentation are located in the content directory.

Website

The PipeCD documentation website is built with Hugo and published at https://pipecd.dev

Docs workflow and versioning

PipeCD’s official site contains multiple versions of documentation, all placed under the /docs/content/en directory:

  • /docs-dev: experimental docs for not-yet-released features or changes.
  • /docs-vX.Y.x: docs for a specific released version family (e.g., docs-v0.56.x, docs-v1.0.x).

Here are the recommended flows for common documentation updates:

  1. Update docs related to an older released version (not the latest released version):
    Update the docs under the corresponding /docs-vX.Y.x directory.

  2. Update docs for not-yet-released features or changes:
    Update the docs under /docs-dev.

  3. Update docs related to the latest released docs version:
    Apply the change in both /docs-dev and the latest /docs-vX.Y.x directory (they share the same structure, so you can find the same page in both).

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

How to run the website locally

Prerequisite

Commands

Run make run/site at the root directory of the repository and then access http://localhost:1313

Note for Windows users: The make run/site command uses make and grep, which are not natively available in Windows PowerShell. You can either use an environment like WSL or run the Hugo command manually in PowerShell:

$env:RELEASE = (Select-String -Path RELEASE -Pattern "^tag:").Line.Split(":")[1].Trim()
hugo server --source=docs