kubernetes-sigs / cloud-provider-kind

Cloud provider for KIND clusters
Apache License 2.0
169 stars 39 forks source link

command(s?) in documentation don't work. #144

Open mikedlr opened 1 week ago

mikedlr commented 1 week ago

In the main documentation there is a command

$ kubectl label node kind-control-plane node.kubernetes.io/exclude-from-external-load-balancers-
node/kind-control-plane unlabeled

This command does not work. I believe that it should be something like

kubectl label node --overwrite kind-2-control-plane node.kubernetes.io/exclude-from-external-load-balancers=true

instead - probably better if the prompt isn't included in the copied text. It might be good if the documents were automatically tested e.g. with https://github.com/JNRowe/shell-doctest

BenTheElder commented 1 week ago

It might be good if the documents were automatically tested e.g. with https://github.com/JNRowe/shell-doctest

that might get a bit expensive since you'd need the requisites setup.

they're also probably not changing often.

I agree that we should have copyable commands.

mikedlr commented 1 week ago

I think that the answer to this bug is that the wrong highlighting code is in use in the documentation

```sh
prompt$ some command
some result
````
prompt$ some command
some result

should be

```console
prompt$ some command
some result
````
propmt$ some command
some result

https://stackoverflow.com/questions/20303826/how-to-highlight-bash-shell-commands-in-markdown