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
docs: updated Developer Guide with changes to make it more accurate #3877
docs: updated Developer Guide with changes to make it more accurate #3877
Conversation
Welcome @rsadowsk! |
Hi @rsadowsk. Thanks for your PR. I'm waiting for a kubernetes-sigs member to verify that this patch is reasonable to test. If it is, they should reply with Once the patch is verified, the new status will be reflected by the I understand the commands that are listed here. Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository. |
18bb2f7
to
7579ca0
Compare
/ok-to-test |
@@ -38,9 +44,10 @@ git fetch upstream | |||
Build `clusterawsadm` in `cluster-api-provider-aws`: | |||
|
|||
```bash | |||
cd "$(go env GOPATH)"/src/sigs.k8s.io/cluster-api-provider-aws/v2 |
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.
Why remove the v2? We are at v2. :)
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.
Ah, never mind. This is for cloning.
make clusterawsadm | ||
mv ./bin/clusterawsadm /usr/local/bin/clusterawsadm | ||
# Optional, move the binary to /usr/local/bin |
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 prefer this to be a move. Because whichever is first in the path will be used instead of the one on the location you copied to. That would be rather bad if you would update one but run the other.
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.
Ok, and I agree with that. Through the dev environment setup guide there were several steps that called the clusterawsadm binary either through ./bin/ or assuming it was moved to your $PATH. I wanted to make the documentation consistent so I changed the mv to optional but it's easily changeable where we always do a move then assume the binary is in the path. I'll make those changes shortly.
Signed-off-by: rjsadowsk <richard.j.sadowski@gmail.com>
7579ca0
to
40075c8
Compare
@Skarlso, I pushed the changes for a mv to always happen and keep referencing clusterawsadm consistent as if it's in your path. |
/approve |
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: Ankitasw The full list of commands accepted by this bot can be found here. The pull request process is described here
Needs approval from an approver in each of these files:
Approvers can indicate their approval by writing |
/lgtm Thanks! |
Signed-off-by: rjsadow richard.j.sadowski@gmail.com
What type of PR is this?
/kind documentation
What this PR does / why we need it:
This PR merges in changes to make the Developer Guide and Development with Tilt documentation more accurate and clear to follow. It updates several minor issues and assumptions made in the live version.
Which issue(s) this PR fixes (optional, in
fixes #<issue number>(, fixes #<issue_number>, ...)
format, will close the issue(s) when PR gets merged):Fixes #3876
Special notes for your reviewer:
Checklist: