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

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

Closed
sayantani11 opened this issue Oct 27, 2021 · 2 comments · Fixed by #5544
Closed

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

sayantani11 opened this issue Oct 27, 2021 · 2 comments · Fixed by #5544
Assignees
Labels
kind/documentation Categorizes issue or PR as related to documentation.
Milestone

Comments

@sayantani11
Copy link
Contributor

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

@k8s-ci-robot k8s-ci-robot added the kind/documentation Categorizes issue or PR as related to documentation. label Oct 27, 2021
@fabriziopandini fabriziopandini added this to the v1.1 milestone Oct 27, 2021
@fabriziopandini
Copy link
Member

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

/milestone v1.1

@sayantani11
Copy link
Contributor Author

@fabriziopandini Yeah sure!
/assign

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
kind/documentation Categorizes issue or PR as related to documentation.
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants