Document and improve starting local development environment

[atpugtihsrah]

What would you like to be added:

• Documentation on how to start a local development environment
• Improve, if possible, starting and setting up a local development environment

Why is this needed:

• There is no documentation on how to start a local development environment which makes it very difficult for new contributors to start contributing.
• Right now its very difficult to start a local development environment, making it easier (if possible) will help new contributors onboard faster.

See Slack: https://cloud-native.slack.com/archives/C01B27F9T0X/p1743926809548959

[khanhtc1202]

Thanks, I will assign this to you @atpugtihsrah

[t-kikuc]

@atpugtihsrah Hi, I'm interested in this problem too.

Since this issue might go bigger, you can create sub-issues or create a task list if you want!

[atpugtihsrah]

@t-kikuc I was thinking about adding a documentation on how to start a local development environment. I can create a sub issue for that. For me just knowing what steps to follow to get a local development environment running was enough to start contributing. I don't know if anything can be done to improve the technical stuff, I feel that once someone knows the steps then its pretty simple to start. What do you think? Do you have ideas about any of the technical stuff to improve?

[atpugtihsrah]

@t-kikuc I created https://github.com/pipe-cd/pipecd/issues/5776 sub-issue but I don't have the edit rights to change/assign relationships to cards. Could you please make it a sub-issue?

[t-kikuc]

@atpugtihsrah Hi, I converted it to a sub-issue 👍

For me just knowing what steps to follow to get a local development environment running was enough to start contributing.

I agree with that for the first step!

Our steps would be like this:

1. Define which components to ease the development for now
   • Only piped? control plane? pipectl?
2. List what steps are needed to start development for each component
3. Check the current docs and find what's missing or unclear
4. Improve the docs above

Do you have ideas about any of the technical stuff to improve?

As for the technical stuff, let's try them when necessary. For example, https://github.com/pipe-cd/pipecd/issues/5770 will improve the testability of SSO features of the control plane like https://github.com/pipe-cd/pipecd/pull/5637.

[eeshaanSA]

Is there any other improvements this issue needs? Happy to brainstorm and help!

[atpugtihsrah]

We don't have anything planned. Feel free to share your ideas here or during the community call.