search

kubernetes-sigs / cloud-provider-kind

Cloud provider for KIND clusters
Apache License 2.0
195 stars 43 forks source link

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

Open zrisher opened 1 week ago

zrisher commented 1 week ago

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 commented 1 week ago

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