-
Notifications
You must be signed in to change notification settings - Fork 211
docs: create 'Contribute to Documentation' guide #6329
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
khanhtc1202
merged 9 commits into
pipe-cd:master
from
shivansh-gohem:shivansh-docs-guide
Nov 24, 2025
Merged
Changes from all commits
Commits
Show all changes
9 commits
Select commit
Hold shift + click to select a range
2da7907
docs: create 'Contribute to Documentation' guide
shivansh-gohem 9881997
docs: relocate guide to contribution-guidelines dir
shivansh-gohem 9c4d526
docs: apply suggestion for version placeholder
shivansh-gohem 2b5fda5
docs: apply suggestions from eeshaanSA
shivansh-gohem 5885dfc
Update docs/content/en/docs-dev/contribution-guidelines/contributing-…
shivansh-gohem c692b17
docs: apply final metadata fix
shivansh-gohem dd12f9e
Update docs/content/en/docs-dev/contribution-guidelines/contributing-…
shivansh-gohem 7c32ba9
docs: apply description fix to v1.0.x file
shivansh-gohem 33ffec4
docs: apply description fix to v1.0.x file
shivansh-gohem File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
40 changes: 40 additions & 0 deletions
40
docs/content/en/docs-dev/contribution-guidelines/contributing-documentation.md
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,40 @@ | ||
| --- | ||
| title: "Contribute to PipeCD Documentation" | ||
| linkTitle: "Contribute to PipeCD Documentation" | ||
| description: > | ||
| This page describes how to contribute to the PipeCD Documentation. | ||
| --- | ||
|
|
||
| Welcome! We are so happy you're interested in helping improve our documentation. Your contributions make the project better for everyone. | ||
|
|
||
| This guide explains how you can contribute to the PipeCD Documentation, which resides on our official website, https://pipecd.dev. | ||
|
|
||
| ## Where to find the docs | ||
|
|
||
| Our documentation is located in the `/docs` folder within the [pipe-cd/pipecd repository](https://github.com/pipe-cd/pipecd). | ||
|
|
||
| The content files are written in Markdown and live inside `/docs/content/en/`. You'll notice two types of documentation folders: | ||
|
|
||
| * `/docs-dev/`: This is for documentation related to unreleased, in-development features. | ||
| * `/docs-v0.x.x/` (and `/docs-v1.0.x/`): These folders contain the documentation for specific released versions of PipeCD. | ||
|
|
||
| ## How to build the docs locally | ||
|
|
||
| To preview your changes as you work, you must run the documentation website on your local machine. | ||
|
|
||
| 1. **Install Prerequisite:** You must have the **extended** version of [Hugo (v0.92.1 or higher)](https://gohugo.io/getting-started/installing/) installed. | ||
| 2. **Run the Server:** From the root of the `pipecd` repository, run the following command: | ||
| ```bash | ||
| make run/site | ||
| ``` | ||
| 3. **Preview:** Open your browser and go to `http://localhost:1313` to see the live-reloading site. | ||
|
|
||
| ## How to submit your changes (The PR Process) | ||
|
|
||
| 1. **Create a Branch:** Create a new branch for your changes (e.g., `git checkout -b my-docs-fix`). | ||
| 2. **Make Your Changes:** Edit the necessary documentation files. If you are fixing an issue in the current documentation, remember to edit the file in both the `/docs-dev/` and the latest `/docs-vx.y.z/` folders. | ||
| 3. **Commit and Push:** Commit your changes with a clear message and push your branch to your fork. | ||
| 4. **Open a Pull Request:** Go to the PipeCD repository and open a Pull Request. In the description, please link to the issue you are fixing (e.g., `Addresses #6124`). | ||
| 5. **Review:** A maintainer will review your PR, provide feedback, and merge it. | ||
|
|
||
| Thank you for contributing! | ||
40 changes: 40 additions & 0 deletions
40
docs/content/en/docs-v1.0.x/contribution-guidelines/contributing-documentation.md
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,40 @@ | ||
| --- | ||
| title: "Contribute to PipeCD Documentation" | ||
| linkTitle: "Contribute to PipeCD Documentation" | ||
| description: > | ||
| This page describes how to contribute to the PipeCD Documentation. | ||
| --- | ||
|
|
||
| Welcome! We are so happy you're interested in helping improve our documentation. Your contributions make the project better for everyone. | ||
|
|
||
| This guide explains how you can contribute to the PipeCD Documentation, which resides on our official website, https://pipecd.dev. | ||
|
|
||
| ## Where to find the docs | ||
|
|
||
| Our documentation is located in the `/docs` folder within the [pipe-cd/pipecd repository](https://github.com/pipe-cd/pipecd). | ||
|
|
||
| The content files are written in Markdown and live inside `/docs/content/en/`. You'll notice two types of documentation folders: | ||
|
|
||
| * `/docs-dev/`: This is for documentation related to unreleased, in-development features. | ||
| * `/docs-v0.x.x/` (and `/docs-v1.0.x/`): These folders contain the documentation for specific released versions of PipeCD. | ||
|
|
||
| ## How to build the docs locally | ||
|
|
||
| To preview your changes as you work, you must run the documentation website on your local machine. | ||
|
|
||
| 1. **Install Prerequisite:** You must have the **extended** version of [Hugo (v0.92.1 or higher)](https://gohugo.io/getting-started/installing/) installed. | ||
| 2. **Run the Server:** From the root of the `pipecd` repository, run the following command: | ||
| ```bash | ||
| make run/site | ||
| ``` | ||
| 3. **Preview:** Open your browser and go to `http://localhost:1313` to see the live-reloading site. | ||
|
|
||
| ## How to submit your changes (The PR Process) | ||
|
|
||
| 1. **Create a Branch:** Create a new branch for your changes (e.g., `git checkout -b my-docs-fix`). | ||
| 2. **Make Your Changes:** Edit the necessary documentation files. If you are fixing an issue in the current documentation, remember to edit the file in both the `/docs-dev/` and the latest `/docs-vx.y.z/` folders. | ||
| 3. **Commit and Push:** Commit your changes with a clear message and push your branch to your fork. | ||
| 4. **Open a Pull Request:** Go to the PipeCD repository and open a Pull Request. In the description, please link to the issue you are fixing (e.g., `Addresses #6124`). | ||
| 5. **Review:** A maintainer will review your PR, provide feedback, and merge it. | ||
|
|
||
| Thank you for contributing! |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.