search

kubernetes-sigs / cluster-api

Home for Cluster API, a subproject of sig-cluster-lifecycle
https://cluster-api.sigs.k8s.io
Apache License 2.0
3.58k stars 1.31k forks source link

Quick Start section needs to make the steps a little more clear #5522

Closed sayantani11 closed 3 years ago

sayantani11 commented 3 years ago

User Story

While starting with the Quick start doc, I was trying to follow the steps as mentioned. But I was stuck at step 1 for a long time unable to proceed. I was not able to understand what can I set the KUBECONFIG variable to. It was bought my notice after some discussion that we will have to choose either step 1 or 2

Detailed Description

https://github.com/kubernetes-sigs/cluster-api/blob/main/docs/book/src/user/quick-start.md#install-andor-configure-a-kubernetes-cluster In the doc, may be we could bold the text of the line that says Choose one of the options or change the numbering, as keeping kubeconfig step as 1 and the kind cluster step as 2, seems like we are supposed to follow this order. This might be helpful for future contributors.

Anything else you would like to add:

It's a very small issue but came to my notice, feel free to close if not relevant.

/kind documentation

fabriziopandini commented 3 years ago

@sayantani11 thanks for the feedback! Are you interested in sending a PR for fixing this?

/milestone v1.1

sayantani11 commented 3 years ago

@fabriziopandini Yeah sure! /assign