docs: create 'Contribute to Documentation' guide#6329
Conversation
shivansh-gohem
force-pushed
the
shivansh-docs-guide
branch
from
125fbf7 to
2de4109
Compare
|
Hi, @khanhtc1202 could you please review my pr |
|
As discussed in the issue, I think you need to relocate the file under |
shivansh-gohem
force-pushed
the
shivansh-docs-guide
branch
from
4357b21 to
ce6a470
Compare
|
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!! |
| ## 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. |
There was a problem hiding this comment.
| 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.
| ## 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. |
There was a problem hiding this comment.
|
Thanks, @khanhtc1202! I've applied the suggested text change to both files!! |
eeshaanSA
left a comment
eeshaanSA
left a comment
There was a problem hiding this comment.
Additionally, it would be also great to explicitly mention that our documentation resides on https://pipecd.dev, our website.
|
|
||
| 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. |
There was a problem hiding this comment.
"how you can contribute to the PipeCD Documentation"
|
@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. 👍 |
|
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>
Signed-off-by: Shivansh Sahu <sahushivansh142@gmail.com>
Signed-off-by: Shivansh Sahu <sahushivansh142@gmail.com>
shivansh-gohem
force-pushed
the
shivansh-docs-guide
branch
from
5c5d6a5 to
2f1cd1c
Compare
|
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! |
|
@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>
shivansh-gohem
force-pushed
the
shivansh-docs-guide
branch
from
2f1cd1c to
2b5fda5
Compare
…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>
|
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. |
|
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
force-pushed
the
shivansh-docs-guide
branch
from
7c32ba9 to
c377398
Compare
|
All changes are done!! |
|
Thanks @shivansh-gohem |
|
@shivansh-gohem check out the EPIC issue, maybe there are more sections you can help on. 👀 |
Signed-off-by: Shivansh Sahu <sahushivansh142@gmail.com>
shivansh-gohem
force-pushed
the
shivansh-docs-guide
branch
from
c377398 to
33ffec4
Compare
3 participants
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:
make run/site)Here is a screenshot of the new page running locally:
Please let me know if you'd like any changes!