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

Untidy prerequisites for “Set up Ingress on Minikube with the NGINX Ingress Controller” #20023

Closed
sftim opened this issue Mar 31, 2020 · 9 comments · Fixed by #20044
Closed
Labels
good first issue Denotes an issue ready for a new contributor, according to the "help wanted" guidelines. help wanted Denotes an issue that needs help from a contributor. Must meet "help wanted" guidelines. kind/cleanup Categorizes issue or PR as related to cleaning up code, process, or technical debt. language/en Issues or PRs related to English language

Comments

@sftim
Copy link
Contributor

sftim commented Mar 31, 2020

This is a Bug Report

Problem:
The page Set up Ingress on Minikube with the NGINX Ingress Controller has a cautionary note about a prerequisite:

Caution: For the Ingress resource to work, the cluster must also have an Ingress controller running.

this note belongs on the page, however the best place for it is in the Prerequisites section.

Proposed Solution:
Edit the page to move the caution note to be the very first thing inside the prerequisites section.

Page to Update:
https://kubernetes.io/docs/tasks/access-application-cluster/ingress-minikube/

/language en
/kind cleanup
/good-first-issue

@k8s-ci-robot
Copy link
Contributor

@sftim:
This request has been marked as suitable for new contributors.

Please ensure the request meets the requirements listed here.

If this request no longer meets these requirements, the label can be removed
by commenting with the /remove-good-first-issue command.

In response to this:

This is a Bug Report

Problem:
The page Set up Ingress on Minikube with the NGINX Ingress Controller has a cautionary note about a prerequisite:

Caution: For the Ingress resource to work, the cluster must also have an Ingress controller running.

this note belongs on the page, however the best place for it is in the Prerequisites section.

Proposed Solution:
Edit the page to move the caution note to be the very first thing inside the prerequisites section.

Page to Update:
https://kubernetes.io/docs/tasks/access-application-cluster/ingress-minikube/

/language en
/kind cleanup
/good-first-issue

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

@k8s-ci-robot k8s-ci-robot added language/en Issues or PRs related to English language good first issue Denotes an issue ready for a new contributor, according to the "help wanted" guidelines. kind/cleanup Categorizes issue or PR as related to cleaning up code, process, or technical debt. help wanted Denotes an issue that needs help from a contributor. Must meet "help wanted" guidelines. labels Mar 31, 2020
@sftim
Copy link
Contributor Author

sftim commented Mar 31, 2020

If you are looking to work on this and would like help, please reply here. I'll watch for replies.

@prasadkatti
Copy link
Contributor

Isn't there an effort underway to move minikube related pages onto the minikube site?
#15969 and kubernetes/minikube#5686

@davivcgarcia
Copy link

I can work on this one! Should I?

@Heena-PyCloud
Copy link
Contributor

If you are looking to work on this and would like help, please reply here. I'll watch for replies.

I am looking to start contributing. looks like ..I can start with this.

@sftim
Copy link
Contributor Author

sftim commented Apr 1, 2020

Go for it! Contributions welcome.

Bear in mind https://www.redhat.com/en/blog/dont-lick-cookie when it comes to deciding if you want to work on this.

@prasadkatti I think this example only happens to use Minikube; a separate PR could rework it to explain how to try out Ingress with a different kind of learning environment.

@davivcgarcia
Copy link

@sftim I'm reviewing the content and looks like the tutorial is explaining how to deploy the Ingress Controller, which is exactly what the caution note is mentioning. IMHO, the caution node should be removed instead of moved to other section.

@davivcgarcia
Copy link

@sftim another good point is that task-tutorial-prereqs.md is saying the user could use Kubernetes playgrounds (Katacoda, play-with-k8s) which are not Minikube.

@sftim
Copy link
Contributor Author

sftim commented Apr 1, 2020

Sure, it's OK to remove the caution note.

#20023 (comment) sounds like it could be a new separate issue(?)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
good first issue Denotes an issue ready for a new contributor, according to the "help wanted" guidelines. help wanted Denotes an issue that needs help from a contributor. Must meet "help wanted" guidelines. kind/cleanup Categorizes issue or PR as related to cleaning up code, process, or technical debt. language/en Issues or PRs related to English language
Projects
None yet
Development

Successfully merging a pull request may close this issue.

5 participants