Website: Untidy prerequisites for “Set up Ingress on Minikube with the NGINX Ingress Controller”

Created on 31 Mar 2020  ·  9Comments  ·  Source: kubernetes/website

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

good first issue help wanted kincleanup languagen

All 9 comments

@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.

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

Isn't there an effort underway to move minikube related pages onto the minikube site?
https://github.com/kubernetes/website/issues/15969 and https://github.com/kubernetes/minikube/issues/5686

I can work on this one! Should I?

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.

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.

@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.

@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.

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

https://github.com/kubernetes/website/issues/20023#issuecomment-607440989 sounds like it could be a new separate issue(?)

Was this page helpful?
0 / 5 - 0 ratings

Related issues

gochist picture gochist  ·  3Comments

gochist picture gochist  ·  3Comments

dheerujava picture dheerujava  ·  4Comments

neha-viswanathan picture neha-viswanathan  ·  3Comments

sftim picture sftim  ·  3Comments