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

Requirement to run with elevated privileges on Mac/Windows should come before command usage in README #163

Open
zrisher opened this issue Nov 26, 2024 · 1 comment

Comments

@zrisher
Copy link
Contributor

zrisher commented Nov 26, 2024

I struggled getting this to work for a while until I scrolled down to the bottom of the README and saw specific instructions to run the command with elevated permissions if using Windows or MacOS.

IMHO, a note about this requirement should be placed closer to the first instructions using the commands. E.g.:

## How to use it

Run a KIND cluster...

**Note**

Control-plane nodes need to remove ...

+ **Note**
+ Windows and Mac users must provide elevated privileges when running the below commands. See [Mac and Windows Support](#mac-and-windows-support).
+

Once the cluster is running, we need to run the `cloud-provider-kind` in a terminal and keep it running...

I think this would save other users some time.

If this change is welcome, let me know and I'll be happy to provide a PR.

@aojea
Copy link
Contributor

aojea commented Nov 26, 2024

We may have a note in the install section to reference the windows and mac section

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants