pipe-cd
Documentation for PipeCD v1 (plugin-arch PipeCD)
NOTE: This issue is for the LFX program and can be considered an epic issue (3 months of work required). Please do not fire PRs before discussing it with the maintainers' team.
What would you like to be added:
Prepare documentation for plugin-arch PipeCD
Related issue https://github.com/pipe-cd/pipecd/issues/5872 Related issue https://github.com/pipe-cd/pipecd/issues/6077
Why is this needed:
Hey! I'm interested in helping complete the documentation for the PipeCD v1 release. I believe I have the recommended skills, and I've recently been learning about CI/CD, which aligns well with this project. I'd love to get started; are there any resources or areas you'd recommend I begin with?
Hi @xenonnn4w this issue is created for LFX Mentorship program. If you feel interest, please check and apply via https://mentorship.lfx.linuxfoundation.org/ , thank you!
Hey @khanhtc1202, I am interested in this project. I am still newbie can I learn on the go? If yes then I would like to apply and contribute to this project for lfx term 3. Thank you.
hi @khanhtc1202, are there any pre-tests or tasks that i should complete before applying
Hey @khanhtc1202 , I am interested in applying to this project in Term 3. Any tips for what to include in the proposal? What will be the selection criteria?
Hi 👋,
I'm interested in contributing to this issue as part of the upcoming LFX Mentorship Term 3. I’ve started exploring the pipedv1 plugin-based architecture and would love to help improve and organize the documentation around it.
I have little experience writing technical documentation and working with CI/CD tools, and I’m comfortable with Markdown and Git workflows. I’m currently reviewing the relevant code and existing docs.
Please let me know the selection criteria and any tips you would like to give to start with.
Looking forward to contributing!
@eeshaanSA
I've been working on the plugin docs in PR #6315 and made a bunch of mistakes initially. After going through khanhtc1202's feedback, I went back and fixed what I could, but he mentioned I should discuss with you for ideas on working on that task. So Could you please look at my changes in my PR and advise me on how to approach this?
Hey @rishabh998186, so sorry for jumping in late. Just seeing the notification now. Let us continue our chat on the PR you have opened.
Hey @eeshaanSA, Would you be able to help me with PR #6315? I've been working on plugin documentation and khanhtc1202 suggested I reach out to you for guidance on the approach. After his feedback, I made some changes that I could. If you could take a look at my changes and give me feedback, it would help me a lot.
@eeshaanSA I prepared the manifests for pipedv1 quickstart, please use this on quickstart docs for v1 👀 https://raw.githubusercontent.com/pipe-cd/pipecd/refs/heads/master/quickstart/manifests/pipedv1-exp.yaml