Skip to content
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

Merged
merged 1 commit into from Nov 24, 2022

Conversation

rjsadow
Copy link
Contributor

@rjsadow rjsadow commented Nov 23, 2022

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:

  • squashed commits
  • includes documentation
  • adds unit tests
  • adds or updates e2e tests

@k8s-ci-robot k8s-ci-robot added the kind/documentation Categorizes issue or PR as related to documentation. label Nov 23, 2022
@linux-foundation-easycla
Copy link

linux-foundation-easycla bot commented Nov 23, 2022

CLA Signed

The committers listed above are authorized under a signed CLA.

  • ✅ login: rsadowsk (aff27a31d6a16d4fcb89e88b02b27af8fa8a29f6)

@k8s-ci-robot k8s-ci-robot added cncf-cla: no Indicates the PR's author has not signed the CNCF CLA. needs-priority labels Nov 23, 2022
@k8s-ci-robot
Copy link
Contributor

Welcome @rsadowsk!

It looks like this is your first PR to kubernetes-sigs/cluster-api-provider-aws 🎉. Please refer to our pull request process documentation to help your PR have a smooth ride to approval.

You will be prompted by a bot to use commands during the review process. Do not be afraid to follow the prompts! It is okay to experiment. Here is the bot commands documentation.

You can also check if kubernetes-sigs/cluster-api-provider-aws has its own contribution guidelines.

You may want to refer to our testing guide if you run into trouble with your tests not passing.

If you are having difficulty getting your pull request seen, please follow the recommended escalation practices. Also, for tips and tricks in the contribution process you may want to read the Kubernetes contributor cheat sheet. We want to make sure your contribution gets all the attention it needs!

Thank you, and welcome to Kubernetes. 😃

@k8s-ci-robot k8s-ci-robot added the needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. label Nov 23, 2022
@k8s-ci-robot
Copy link
Contributor

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 /ok-to-test on its own line. Until that is done, I will not automatically test new commits in this PR, but the usual testing commands by org members will still work. Regular contributors should join the org to skip this step.

Once the patch is verified, the new status will be reflected by the ok-to-test label.

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.

@k8s-ci-robot k8s-ci-robot added size/S Denotes a PR that changes 10-29 lines, ignoring generated files. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. and removed cncf-cla: no Indicates the PR's author has not signed the CNCF CLA. labels Nov 23, 2022
@rjsadow rjsadow force-pushed the development-doc-update branch 2 times, most recently from 18bb2f7 to 7579ca0 Compare November 23, 2022 17:41
@Skarlso
Copy link
Contributor

Skarlso commented Nov 23, 2022

/ok-to-test

@k8s-ci-robot k8s-ci-robot added ok-to-test Indicates a non-member PR verified by an org member that is safe to test. and removed needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. labels Nov 23, 2022
@@ -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
Copy link
Contributor

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. :)

Copy link
Contributor

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
Copy link
Contributor

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.

Copy link
Contributor Author

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>
@rjsadow
Copy link
Contributor Author

rjsadow commented Nov 23, 2022

@Skarlso, I pushed the changes for a mv to always happen and keep referencing clusterawsadm consistent as if it's in your path.

@Ankitasw
Copy link
Member

/approve
cc @Skarlso for final review

@k8s-ci-robot
Copy link
Contributor

[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 /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@k8s-ci-robot k8s-ci-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Nov 24, 2022
@Skarlso
Copy link
Contributor

Skarlso commented Nov 24, 2022

/lgtm

Thanks!

@k8s-ci-robot k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Nov 24, 2022
@k8s-ci-robot k8s-ci-robot merged commit 3586b3b into kubernetes-sigs:main Nov 24, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
approved Indicates a PR has been approved by an approver from all required OWNERS files. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. kind/documentation Categorizes issue or PR as related to documentation. lgtm "Looks good to me", indicates that a PR is ready to be merged. needs-priority ok-to-test Indicates a non-member PR verified by an org member that is safe to test. size/S Denotes a PR that changes 10-29 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Documentation Issue: Developer Guide is out of date
4 participants