pipe-cd
[EPIC] Improve and Expand Contributing Section in Documentation
The current Contributing section on pipecd.dev only links to CONTRIBUTING.md and a basic architecture page. While helpful, it lacks the depth and guidance needed to support both new contributors and users.
Goals
- Make the section more welcoming for first-time contributors.
- Provide clear pathways for different contribution types (docs, code, design, translations, etc.).
- Include architecture context, but also practical steps for setup, workflow, and PR process.
- Highlight community channels, issue labels, and where to seek help
Discussion Prompt:
What content, guidance, or structure would make this section more useful? Share your ideas below.
To get us started, here is what I propose:
the current Contributor Guide can be renamed to simply Contribute, making it inline with other CNCF project styles.
Suggested Structure
Under the new Contribute section, we could organize the following sub-sections:
- Contribute to PipeCD
- Contribute to PipeCD Documentation
- Contribute to PipeCD Blogs
- Contribute to piped Plugins
Rationale
After reviewing documentation structures of several established CNCF projects and skimming through Kubernetes docs, this structure seems like a clear and approachable way. It separates contribution areas explicitly while keeping the top-level entry point clean.
I would love to take in more thoughts.
cc: @khanhtc1202 @t-kikuc @Warashi
Note: We will add contributing docs for PipeCD doc contribution, blogs contribution, and plugins contribution to the PipeCD contribute session on pipecd.dev
Hi @eeshaanSA and @khanhtc1202, I'm a new contributor looking to help with open-source documentation and I'm very interested in this issue.
The 4-part structure you agreed on looks great. If no one is working on this, I would like to start by tackling the 'Contribute to PipeCD Documentation' section.
I can write a new document that explains the process for submitting documentation changes (e.g., where the docs are located, how to build them locally, and the PR review process).
Please let me know if this is a good way to get started!!
Sounds great, @shivansh-gohem! Looking forward to your PR. You can start working on it, I will get it assigned to you.
Hi @eeshaanSA, thanks for the nudge! I'd love to keep going. I will tackle the 'Contribute to piped Plugins' section next !!!!
@shivansh-gohem good idea. A better idea is to tackle Contributing to Blogs first, as it is fairly straight forward. 😄
Got it, @eeshaanSA! I appreciate the advice.
I'll switch gears and tackle the 'Contribute to PipeCD Blogs' section first. I'll open a PR for that shortly!