-
Notifications
You must be signed in to change notification settings - Fork 8.3k
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
What is the state of the move? #213
Comments
As described in the README we're moving over: https://github.com/kubernetes/ingress#description Please open a pr with missing content, we're shutting down contrib kubernetes-retired/contrib#2365 Existing examples have an nginx/ subdir: https://github.com/kubernetes/ingress/tree/master/examples Configuration is described here https://github.com/kubernetes/ingress/blob/master/controllers/nginx/configuration.md |
Ideally one shouldn't require a lengthy README, just a brief landing page that sends users to the example section. I'm fine just porting over the README from contrib but we have evidence that it confused a lot of people (both the nginx and gce README), so it might need some refactoring. |
I see. The last sentence there was what I was curious about. I'll try to address this with my other nginx changes, probably over the weekend. Thanks @bprashanth . |
The number 1 complaint we got in contrib was the lack of consistent documentation. This is basically the docs TODO list https://github.com/kubernetes/ingress/labels/area%2Fdocs, I think we should try and avoid the ginormous README if at all possible, though all controllers certainly require a README. A user shouldn't have to sift through implementation notes, and an admin should easily be able to find different deployment styles. In the past we mixed these and confused everyone. |
I re-added the REAMDE and config docs (#262), still needs a refactor |
Closing. The nginx docs were restored and the examples are updated. |
What is going on with this repo? There's a weird mix of content missing from
contrib/ingress
and then there's stuff that has been moved over in a far diminished capacity. I have no idea where to point someone for intro information about thenginx-ingress-controller
.https://github.com/kubernetes/ingress/tree/master/controllers is missing a ton of content compared to https://github.com/kubernetes/contrib/tree/master/ingress/controllers
This README is completely empty: https://github.com/kubernetes/ingress/tree/master/controllers/nginx
Etc.
The text was updated successfully, but these errors were encountered: