Skip to content

Conversation

@mohammedfirdouss
Copy link
Contributor

  • Expand contributing.md with community, dev setup, and PR process
  • Rename "Contributing" to "Contribute to PipeCD"
  • Apply changes to docs-dev and docs-v1.0.x

Addresses #6124

Copy link

Copilot AI left a 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.

Copy link
Contributor

@eeshaanSA eeshaanSA left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hey, thanks for this @mohammedfirdouss!

I checked the files, and while they look good, what do you think of making some more structural changes (better flow of data and sections), and also some more info on how to setup the a local dev guide? The reference to CONTRIBUTING.md is fine, but the CONTRIBUTING.md itself is outdated, so it is better to just have all the information in one page on the website.

@mohammedfirdouss
Copy link
Contributor Author

mohammedfirdouss commented Jan 4, 2026

Hey, thanks for this @mohammedfirdouss!

I checked the files, and while they look good, what do you think of making some more structural changes (better flow of data and sections), and also some more info on how to setup the a local dev guide? The reference to CONTRIBUTING.md is fine, but the CONTRIBUTING.md itself is outdated, so it is better to just have all the information in one page on the website.

Thanks for the feedback @eeshan! Hmm, Okay the website docs page should be self-contained rather than referencing CONTRIBUTING.md.

TO-DO

  • Better structured sections with clear flow
  • Complete local dev setup guide inline (Control Plane, Piped agent, port-forwarding, etc.)
  • Full PR process details instead of just linking to CONTRIBUTING.md

@eeshaanSA This should address the issue already yeah? I am open to feedbacks

…ty engagement details

Signed-off-by: Mohammed Firdous <[email protected]>
Copy link
Contributor

@eeshaanSA eeshaanSA left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM, @mohammedfirdouss.

Thanks a lot for your contributions! 🚀

@mohammedfirdouss
Copy link
Contributor Author

LGTM, @mohammedfirdouss.

Thanks a lot for your contributions! 🚀

Thank you for the reviews as well @eeshaanSA. Ready for more contributions!

@eeshaanSA eeshaanSA added area/docs approved ready-to-merge PRs that are marked ready to merge by ORG Members and removed ready-to-merge PRs that are marked ready to merge by ORG Members labels Jan 7, 2026
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We can also change the file names to contributing-to-pipecd.md or something similar. contributing.md looks vague.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hmm, this should be straightforward like you say but i feel the naming might be to long

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, you are right, but it is better to keep things clear, because we might need more pages here in the future.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No problem, i have made a change to this effect.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I might be nitpicking, but @mohammedfirdouss, what do you think about 'Join the Community' section being repositioned somewhere at the bottom? Would love to know your thoughts!

Copy link
Contributor Author

@mohammedfirdouss mohammedfirdouss Jan 9, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That makes sense to me. Moving Join the Community to the bottom should focus on how to contribute first, and people can find community links after.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants