Add documentation on a single page on how to start a local dev env #5798
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
atpugtihsrah
requested review from
khanhtc1202,
ffjlabo,
t-kikuc and
Warashi
as code owners
Signed-off-by: Harshit Gupta <[email protected]>
atpugtihsrah
force-pushed
the
local-dev-env-5776
branch
from
e0fa215 to
a212421
Compare
|
@t-kikuc This is what I had in mind. What do you think? |
t-kikuc
reviewed
May 6, 2025
There was a problem hiding this comment.
@atpugtihsrah
Thank you so much!!! Amazing! Almost LGTM.
I left some nit comments.
Later let's add links to this file somewhere (e.g. quickstart docs)
|
|
||
| Run `make kind-down` to stop and delete the registery and the cluster. | ||
|
|
||
| ### Run Pipecd Control Plane |
There was a problem hiding this comment.
[nit]
Suggested change
| ### Run Pipecd Control Plane | |
| ### Run PipeCD Control Plane |
Comment on lines
+200
to
+201
| # Base64 encoded string of the piped private key. You can generate it by the following command. | ||
| # echo -n "your-piped-key" | base64 |
There was a problem hiding this comment.
Suggested change
| # Base64 encoded string of the piped private key. You can generate it by the following command. | |
| # echo -n "your-piped-key" | base64 | |
| # Base64 encoded string of the piped private key. |
Now we can directly get a base64-encoded key.
|
|
||
| This will create the kubernetes namespace `pipecd` if it does not exist and start a local registry in the namespace which can then be accessed by other components. | ||
|
|
||
| Run `make kind-down` to stop and delete the registery and the cluster. |
There was a problem hiding this comment.
[nit] I want to clarify that this line is necessary only when cleaning up. (Or, create a ### Cleaning up section)
Suggested change
| Run `make kind-down` to stop and delete the registery and the cluster. | |
| When cleaning up, run `make kind-down` to stop and delete the registery and the cluster. |
Run
make stop/pipecdto stop PipeCD Control Plane. (L171)
the same
| @@ -152,6 +152,73 @@ If your change introcudes a user-facing change, please update the following sect | |||
|
|
|||
| Note that if it's a new breaking change, make sure to complete the two latter questions. | |||
|
|
|||
| ## Starting a Local Development Environment | |||
There was a problem hiding this comment.
Let's move this new section to under "Development"
## Development
...
Note: While working with the PipeCD codebase, you may refer to [Makefile](./Makefile) for useful commands.
### Starting a Local Development Environment //HERE
...
### Online one-click setup for contributing
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What this PR does: It adds a single documentation on a single page on how to start a local dev env.
Why we need it: What I needed to speed up contribution was a single documentation. This PR should be helpful for new contributors to start a local dev env faster.
Which issue(s) this PR fixes: Closes #5776
Fixes #
Does this PR introduce a user-facing change?: No