Cleanup README.md (#5037)
This commit is contained in:
parent
0f7cd7b6a4
commit
a9f19b7f98
1 changed files with 31 additions and 40 deletions
71
README.md
71
README.md
|
@ -11,55 +11,46 @@
|
||||||
[](https://github.com/kubernetes/ingress-nginx/blob/master/CONTRIBUTING.md)
|
[](https://github.com/kubernetes/ingress-nginx/blob/master/CONTRIBUTING.md)
|
||||||
[](https://app.fossa.io/projects/git%2Bgithub.com%2Fkubernetes%2Fingress-nginx?ref=badge_shield)
|
[](https://app.fossa.io/projects/git%2Bgithub.com%2Fkubernetes%2Fingress-nginx?ref=badge_shield)
|
||||||
|
|
||||||
|
## Overview
|
||||||
|
|
||||||
|
ingress-nginx is an Ingress controller for Kubernetes using [NGINX](https://www.nginx.org/) as a reverse proxy and load balancer.
|
||||||
|
|
||||||
|
Learn more about Ingress on the main [Kubernetes](https://kubernetes.io/docs/concepts/services-networking/ingress/) documentation site.
|
||||||
|
|
||||||
|
## Get started
|
||||||
|
|
||||||
|
See the [Getting Started](https://kubernetes.github.io/ingress-nginx/deploy/) document.
|
||||||
|
|
||||||
|
## Troubleshooting
|
||||||
|
|
||||||
|
If you encounter issues, review the [troubleshooting docs](docs/troubleshooting.md), [file an issue](https://github.com/kubernetes/ingress-nginx/issues), or talk to us on the [#ingress-nginx channel](https://kubernetes.slack.com/messages/ingress-nginx) on the Kubernetes Slack server.
|
||||||
|
|
||||||
|
## Contributing
|
||||||
|
|
||||||
|
Thanks for taking the time to join our community and start contributing!
|
||||||
|
|
||||||
|
- This project adheres to the [Kubernetes Community Code of Conduct](https://git.k8s.io/community/code-of-conduct.md). By participating in this project, you agree to abide by its terms.
|
||||||
|
- See [CONTRIBUTING.md](CONTRIBUTING.md) for information about setting up your environment, the workflow that we expect, and instructions on the developer certificate of origin that we require.
|
||||||
|
- Check out the [open issues](https://github.com/kubernetes/ingress-nginx).
|
||||||
|
- Join our Kubernetes Slack channel: [#ingress-nginx](https://kubernetes.slack.com/messages/CANQGM8BA/)
|
||||||
|
|
||||||
|
## Changelog
|
||||||
|
|
||||||
|
See [the list of releases](https://github.com/kubernetes/ingress-nginx/releases) to find out about feature changes
|
||||||
|
For detailed changes for each release; please check the [Changelog.md](Changelog.md)
|
||||||
|
|
||||||
# Get Involved
|
# Get Involved
|
||||||
|
|
||||||
- **Contributing**: Pull requests are welcome!
|
- **Contributing**: Pull requests are welcome!
|
||||||
- Read [`CONTRIBUTING.md`](CONTRIBUTING.md) and check out [help-wanted](https://github.com/kubernetes/ingress-nginx/labels/help%20wanted) issues
|
- Read [`CONTRIBUTING.md`](CONTRIBUTING.md) and check out [help-wanted](https://github.com/kubernetes/ingress-nginx/labels/help%20wanted) issues
|
||||||
- Submit github issues for any feature enhancements, bugs or documentation problems
|
- Submit github issues for any feature enhancements, bugs or documentation problems
|
||||||
- **Support**: Join to [Kubernetes Slack](http://slack.kubernetes.io/) to ask questions to get support from the maintainers and other developers
|
- **Support**: Join to [Kubernetes Slack](http://slack.kubernetes.io/) in the [#ingress-nginx](https://kubernetes.slack.com/messages/CANQGM8BA/) channel to ask questions to get support from the maintainers and other users
|
||||||
- Questions/comments can also be posted as [github issues](https://github.com/kubernetes/ingress-nginx/issues)
|
- The [github issues](https://github.com/kubernetes/ingress-nginx/issues) in the repository are **exclusively** for bug reports and feature requests.
|
||||||
- **Discuss**: Tweet using the `#IngressNginx` hashtag
|
- **Discuss**: Tweet using the `#IngressNginx` hashtag
|
||||||
|
|
||||||
## Description
|
|
||||||
|
|
||||||
This repository contains the NGINX controller built around the [Kubernetes Ingress resource](http://kubernetes.io/docs/user-guide/ingress/) that uses [ConfigMap](https://kubernetes.io/docs/tasks/configure-pod-container/configure-pod-configmap/#understanding-configmaps-and-pods) to store the NGINX configuration. [Make Ingress-Nginx Work for you, and the Community](https://youtu.be/GDm-7BlmPPg) from KubeCon Europe 2018 is a great video to get you started!!
|
|
||||||
|
|
||||||
Learn more about using Ingress on [k8s.io](https://kubernetes.io/docs/concepts/services-networking/ingress/)
|
|
||||||
|
|
||||||
### What is an Ingress Controller?
|
|
||||||
|
|
||||||
Configuring a webserver or loadbalancer is harder than it should be. Most webserver configuration files are very similar. There are some applications that have weird little quirks that tend to throw a wrench in things, but for the most part you can apply the same logic to them and achieve a desired result.
|
|
||||||
|
|
||||||
The Ingress resource embodies this idea, and an Ingress controller is meant to handle all the quirks associated with a specific "class" of Ingress.
|
|
||||||
|
|
||||||
An Ingress Controller is a daemon, deployed as a Kubernetes Pod, that watches the apiserver's `/ingresses` endpoint for updates to the [Ingress resource](https://kubernetes.io/docs/concepts/services-networking/ingress/). Its job is to satisfy requests for Ingresses.
|
|
||||||
|
|
||||||
## Documentation
|
|
||||||
|
|
||||||
To check out [Live Docs](https://kubernetes.github.io/ingress-nginx/)
|
|
||||||
|
|
||||||
## Questions
|
|
||||||
|
|
||||||
For questions and support please use the [#ingress-nginx](https://kubernetes.slack.com/messages/CANQGM8BA/) channel in the [Kubernetes Slack](http://slack.kubernetes.io/) or post to the [Kubernetes Forum](https://discuss.kubernetes.io). The issue list of this repo is **exclusively** for bug reports and feature requests.
|
|
||||||
|
|
||||||
## Issues
|
## Issues
|
||||||
|
|
||||||
Please make sure to read the [Issue Reporting Checklist](https://github.com/kubernetes/ingress-nginx/blob/master/CONTRIBUTING.md#issue-reporting-guidelines) before opening an issue. Issues not conforming to the guidelines may be closed immediately.
|
Please make sure to read the [Issue Reporting Checklist](https://github.com/kubernetes/ingress-nginx/blob/master/CONTRIBUTING.md#issue-reporting-guidelines) before opening an issue. Issues not conforming to the guidelines **may be closed immediately**.
|
||||||
|
|
||||||
## Changelog
|
|
||||||
|
|
||||||
Detailed changes for each release are documented in the [Changelog.md](Changelog.md)
|
|
||||||
|
|
||||||
## Contribution
|
|
||||||
|
|
||||||
Please make sure to read the [Contributing Guide](CONTRIBUTING.md) before making a pull request.
|
|
||||||
|
|
||||||
Thank you to all the people who already contributed to NGINX Ingress Controller!
|
|
||||||
|
|
||||||
## Code of Conduct
|
|
||||||
|
|
||||||
This project adheres to the [Kubernetes Community Code of Conduct](https://git.k8s.io/community/code-of-conduct.md).
|
|
||||||
By participating in this project you agree to abide by its terms.
|
|
||||||
|
|
||||||
## License
|
## License
|
||||||
|
|
||||||
|
|
Loading…
Reference in a new issue