docs: create 'Contribute to Documentation' guide #6329

shivansh-gohem · 2025-10-27T11:05:32Z

Hi @eeshaanSA and @khanhtc1202,

As discussed in issue #6124, this PR adds the new "Contribute to PipeCD Documentation" guide.

Following the project's documentation workflow, I've added the new file (contributing-documentation.md) to both:

docs/content/en/docs-dev/
docs/content/en/docs-v1.0.x/

This new page provides a clear guide for new contributors, covering:

Where to find the documentation files
How to build the site locally (make run/site)
The standard PR process for doc changes

Here is a screenshot of the new page running locally:

Please let me know if you'd like any changes!

shivansh-gohem · 2025-10-31T12:49:26Z

Hi, @khanhtc1202 could you please review my pr

khanhtc1202 · 2025-11-04T07:18:26Z

As discussed in the issue, I think you need to relocate the file under /docs-dev/contribution-guidelines/ directory (same level with contributing.md and architecture-overview.md, isn't it?
cc @eeshaanSA
ref: #6124 (comment)

shivansh-gohem · 2025-11-05T16:47:54Z

Thanks for the review, @khanhtc1202!

I've moved the file into the contribution-guidelines directory for both docs-dev and docs-v1.0.x as requested. Please let me know if this is correct!!

khanhtc1202 · 2025-11-06T09:00:25Z

docs/content/en/docs-dev/contribution-guidelines/contributing-documentation.md

+## 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-v1.0.x/` folders.


Suggested change

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-v1.0.x/` folders.

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.

nits, since we maintain both v0.55.x and v1.0.x in the meantime.

khanhtc1202 · 2025-11-06T09:00:54Z

docs/content/en/docs-v1.0.x/contribution-guidelines/contributing-documentation.md

+## 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-v1.0.x/` folders.


same as https://github.com/pipe-cd/pipecd/pull/6329/files#r2498093690

shivansh-gohem · 2025-11-06T17:37:28Z

Thanks, @khanhtc1202! I've applied the suggested text change to both files!!

eeshaanSA

Additionally, it would be also great to explicitly mention that our documentation resides on https://pipecd.dev, our website.

eeshaanSA · 2025-11-14T10:24:45Z

docs/content/en/docs-dev/contribution-guidelines/contributing-documentation.md

+
+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 submit documentation changes.


"how you can contribute to the PipeCD Documentation"

eeshaanSA · 2025-11-14T10:28:41Z

@shivansh-gohem Sorry for the delay in response.

The overall structure looks good, just some minor changes and this should be merged into the main. Thank you for your contribution. 👍

shivansh-gohem · 2025-11-14T11:30:06Z

Thank you, @eeshaanSA! I appreciate the feedback. I've just pushed a commit that applies both of your suggestions to the files. Thanks for guiding this!

Signed-off-by: Shivansh Sahu <sahushivansh142@gmail.com>

shivansh-gohem · 2025-11-14T17:14:51Z

Thanks, @eeshaanSA! I've updated the metadata in both files to include description and the correct weight: 4.

I've also rebased the branch to resolve the 'out-of-date' warning. Please let me know if this looks good!

eeshaanSA · 2025-11-14T17:39:21Z

@shivansh-gohem, please take a look at the metadata from other files on the documentation. Here is one for reference. I understand it can be overwhelming, but it is fairly easy once you take a look.

Signed-off-by: Shivansh Sahu <sahushivansh142@gmail.com>

docs/content/en/docs-dev/contribution-guidelines/contributing-documentation.md

…documentation.md Co-authored-by: Eeshaan Sawant <100678386+eeshaanSA@users.noreply.github.com> Signed-off-by: shivansh-gohem <sahushivansh142@gmail.com>

Signed-off-by: Shivansh Sahu <sahushivansh142@gmail.com>

shivansh-gohem · 2025-11-15T10:15:21Z

Hi @eeshaanSA, thank you for all the help! I've just pushed the final metadata fix to both files, matching your suggestion. I believe it's all correct now.

docs/content/en/docs-dev/contribution-guidelines/contributing-documentation.md

eeshaanSA · 2025-11-15T11:38:44Z

LGTM 🚀 with nits

cc @khanhtc1202

…documentation.md Co-authored-by: Eeshaan Sawant <100678386+eeshaanSA@users.noreply.github.com> Signed-off-by: shivansh-gohem <sahushivansh142@gmail.com>

Signed-off-by: Shivansh Sahu <sahushivansh142@gmail.com>

shivansh-gohem · 2025-11-15T12:03:16Z

All changes are done!!

eeshaanSA · 2025-11-17T07:16:59Z

Thanks @shivansh-gohem

eeshaanSA

LGTM 🚀

eeshaanSA · 2025-11-18T10:35:57Z

@shivansh-gohem check out the EPIC issue, maybe there are more sections you can help on. 👀

Signed-off-by: Shivansh Sahu <sahushivansh142@gmail.com>

khanhtc1202

Thanks @shivansh-gohem 🙌

shivansh-gohem requested a review from a team as a code owner October 27, 2025 11:05

shivansh-gohem requested review from Warashi, khanhtc1202 and t-kikuc October 27, 2025 11:05

shivansh-gohem force-pushed the shivansh-docs-guide branch from 125fbf7 to 2de4109 Compare October 27, 2025 11:07

shivansh-gohem force-pushed the shivansh-docs-guide branch from 4357b21 to ce6a470 Compare November 5, 2025 16:47

khanhtc1202 reviewed Nov 6, 2025

View reviewed changes

eeshaanSA requested changes Nov 14, 2025

View reviewed changes

shivansh-gohem added 3 commits November 14, 2025 17:13

docs: create 'Contribute to Documentation' guide

2da7907

Signed-off-by: Shivansh Sahu <sahushivansh142@gmail.com>

docs: relocate guide to contribution-guidelines dir

9881997

Signed-off-by: Shivansh Sahu <sahushivansh142@gmail.com>

docs: apply suggestion for version placeholder

9c4d526

Signed-off-by: Shivansh Sahu <sahushivansh142@gmail.com>

shivansh-gohem force-pushed the shivansh-docs-guide branch from 5c5d6a5 to 2f1cd1c Compare November 14, 2025 17:14

docs: apply suggestions from eeshaanSA

2b5fda5

Signed-off-by: Shivansh Sahu <sahushivansh142@gmail.com>

shivansh-gohem force-pushed the shivansh-docs-guide branch from 2f1cd1c to 2b5fda5 Compare November 15, 2025 05:11

eeshaanSA reviewed Nov 15, 2025

View reviewed changes

docs/content/en/docs-dev/contribution-guidelines/contributing-documentation.md Show resolved Hide resolved

shivansh-gohem and others added 2 commits November 15, 2025 15:33

Update docs/content/en/docs-dev/contribution-guidelines/contributing-…

5885dfc

…documentation.md Co-authored-by: Eeshaan Sawant <100678386+eeshaanSA@users.noreply.github.com> Signed-off-by: shivansh-gohem <sahushivansh142@gmail.com>

docs: apply final metadata fix

c692b17

Signed-off-by: Shivansh Sahu <sahushivansh142@gmail.com>

eeshaanSA requested changes Nov 15, 2025

View reviewed changes

docs/content/en/docs-dev/contribution-guidelines/contributing-documentation.md Outdated Show resolved Hide resolved

Update docs/content/en/docs-dev/contribution-guidelines/contributing-…

dd12f9e

…documentation.md Co-authored-by: Eeshaan Sawant <100678386+eeshaanSA@users.noreply.github.com> Signed-off-by: shivansh-gohem <sahushivansh142@gmail.com>

docs: apply description fix to v1.0.x file

7c32ba9

Signed-off-by: Shivansh Sahu <sahushivansh142@gmail.com>

shivansh-gohem force-pushed the shivansh-docs-guide branch from 7c32ba9 to c377398 Compare November 15, 2025 12:02

eeshaanSA approved these changes Nov 18, 2025

View reviewed changes

docs: apply description fix to v1.0.x file

33ffec4

Signed-off-by: Shivansh Sahu <sahushivansh142@gmail.com>

shivansh-gohem force-pushed the shivansh-docs-guide branch from c377398 to 33ffec4 Compare November 18, 2025 12:31

khanhtc1202 approved these changes Nov 24, 2025

View reviewed changes

khanhtc1202 enabled auto-merge (squash) November 24, 2025 06:08

khanhtc1202 merged commit ea02853 into pipe-cd:master Nov 24, 2025
43 checks passed

khanhtc1202 mentioned this pull request Nov 24, 2025

Fix failed site build #6360

Merged

github-actions bot mentioned this pull request Dec 23, 2025

Release v0.56.0 #6387

Open

mohammedfirdouss mentioned this pull request Jan 3, 2026

[EPIC] Improve and Expand Contributing Section in Documentation #6124

Open

	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-v1.0.x/` folders.
	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.


		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 submit documentation changes.

docs: create 'Contribute to Documentation' guide #6329

docs: create 'Contribute to Documentation' guide #6329

Uh oh!

Conversation

shivansh-gohem commented Oct 27, 2025

Uh oh!

shivansh-gohem commented Oct 31, 2025

Uh oh!

khanhtc1202 commented Nov 4, 2025

Uh oh!

shivansh-gohem commented Nov 5, 2025

Uh oh!

khanhtc1202 Nov 6, 2025

Choose a reason for hiding this comment

Uh oh!

khanhtc1202 Nov 6, 2025

Choose a reason for hiding this comment

Uh oh!

shivansh-gohem commented Nov 6, 2025

Uh oh!

eeshaanSA left a comment

Choose a reason for hiding this comment

Uh oh!

eeshaanSA Nov 14, 2025

Choose a reason for hiding this comment

Uh oh!

eeshaanSA commented Nov 14, 2025

Uh oh!

shivansh-gohem commented Nov 14, 2025

Uh oh!

shivansh-gohem commented Nov 14, 2025

Uh oh!

eeshaanSA commented Nov 14, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

shivansh-gohem commented Nov 15, 2025

Uh oh!

Uh oh!

eeshaanSA commented Nov 15, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

shivansh-gohem commented Nov 15, 2025

Uh oh!

eeshaanSA commented Nov 17, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

eeshaanSA left a comment

Choose a reason for hiding this comment

Uh oh!

eeshaanSA commented Nov 18, 2025

Uh oh!

khanhtc1202 left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

eeshaanSA commented Nov 14, 2025 •

edited

Loading

eeshaanSA commented Nov 15, 2025 •

edited

Loading

eeshaanSA commented Nov 17, 2025 •

edited

Loading