docs: add 'Contribute to piped Plugins' guide #6398
Conversation
mohammedfirdouss
commented
Jan 3, 2026
mohammedfirdouss
commented
- Add contributing-plugins.md with plugin architecture overview and development guidelines
- Apply changes to docs-dev and docs-v1.0.x
- Addresses [EPIC] Improve and Expand Contributing Section in Documentation #6124
Signed-off-by: Mohammed Firdous <[email protected]>
|
Hey @mohammedfirdouss, left some comments, PTAL when you have time! |
Alright @eeshaanSA. No comments here, maybe the other PRs? |
docs/content/en/docs-dev/contribution-guidelines/contributing-plugins.md
Outdated
Show resolved
Hide resolved
docs/content/en/docs-dev/contribution-guidelines/contributing-plugins.md
Outdated
Show resolved
Hide resolved
docs/content/en/docs-dev/contribution-guidelines/contributing-plugins.md
Outdated
Show resolved
Hide resolved
|
|
||
| - **Plugins** run as gRPC servers, launched and managed by piped | ||
| - **Deploy targets** define where a plugin deploys (e.g., a Kubernetes cluster) | ||
| - Plugins can be **official** (maintained by PipeCD team) or **community-contributed** |
There was a problem hiding this comment.
some more info here about official plugins (expanded info about how they are maintained) can be good to have, though not necessary. Current version looks good too! Please comment if you have any ideas.
There was a problem hiding this comment.
Sure no problem @eeshaanSA, For now I have no ideas yet but i updated docs-dev/concepts with v1 content (was still showing old Platform Provider docs) and added links from the plugins guide to the Concepts page for readers who want more background on the architecture.
|
@mohammedfirdouss, sorry, my bad. I had not finished the review yet. PTAL now, you should see them! |
Yes I can. Thanks! @eeshaanSA |
…ails and updates Signed-off-by: Mohammed Firdous <[email protected]>
…plugins Signed-off-by: Mohammed Firdous <[email protected]>
eeshaanSA
left a comment
eeshaanSA
left a comment
There was a problem hiding this comment.
Hey @mohammedfirdouss, PTAL when you have time! Thanks
docs/content/en/docs-dev/contribution-guidelines/contributing-plugins.md
Outdated
Show resolved
Hide resolved
Signed-off-by: Mohammed Firdous <[email protected]>
Signed-off-by: Mohammed Firdous <[email protected]>
docs/content/en/docs-v1.0.x/contribution-guidelines/contributing-plugins.md
Outdated
Show resolved
Hide resolved
| |--------|------------|-------------------| | ||
| | [wait](https://github.com/pipe-cd/pipecd/tree/master/pkg/app/pipedv1/plugin/wait) | Simple | Basic plugin structure | | ||
| | [waitapproval](https://github.com/pipe-cd/pipecd/tree/master/pkg/app/pipedv1/plugin/waitapproval) | Simple | Stage-only plugin | | ||
| | [kubernetes](https://github.com/pipe-cd/pipecd/tree/master/pkg/app/pipedv1/plugin/kubernetes) | Complex | Full-featured plugin | |
There was a problem hiding this comment.
We can also add the terraform plugin here, and maybe even some community plugins (Like the openTofu one). Thoughts?
There was a problem hiding this comment.
Hmm, I will say yes, why so is because, it should give contributors more examples to learn from so that they can understand patterns.
Signed-off-by: Mohammed Firdous <[email protected]>
2 participants
