-
Notifications
You must be signed in to change notification settings - Fork 208
docs: add 'Contribute to piped Plugins' guide #6398
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
base: master
Are you sure you want to change the base?
docs: add 'Contribute to piped Plugins' guide #6398
Conversation
mohammedfirdouss
commented
Jan 3, 2026
- 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]>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Copilot encountered an error and was unable to review this pull request. You can try again by re-requesting a review.
|
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.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Hey @mohammedfirdouss, PTAL when you have time! Thanks
docs/content/en/docs-dev/contribution-guidelines/contributing-plugins.md
Outdated
Show resolved
Hide resolved
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
These changes don't look relevant to the PR. If this is about improving the texts in concepts section, it would be better to make a different PR for it.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think we can open another PR for that, i will go ahead to remove them now. Also, Should we add a version note indicating this applies to v1?
Signed-off-by: Mohammed Firdous <[email protected]>
Signed-off-by: Mohammed Firdous <[email protected]>