Chore: Update README.md - #10112
Open
sean-breen wants to merge 18 commits into
Open
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
This PR revamps README.md to make the NGINX Ingress Controller repository more user-friendly by adding a short product summary, reorganizing sections (Features/Quick Start/Docs/Images/Releases/Community), and consolidating key links into tables.
Changes:
- Adds a new landing structure with tagline, badges, and table of contents.
- Introduces streamlined sections for Features, Quick Start, Documentation, Docker Images, and Releases (including LTS + SBOM info).
- Expands and reorganizes Community information, including community call dates through October 2026.
vepatel
reviewed
Jun 4, 2026
javorszky
previously approved these changes
Jun 4, 2026
javorszky
left a comment
Contributor
There was a problem hiding this comment.
One tiny nit I don't actually care about that much.
Broader question: what is the reason for the document reorg? Was there a pain point by someone / someones? Asking more for traceability than anything.
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com> Co-authored-by: Gabor Javorszky <gabor@javorszky.co.uk> Signed-off-by: Sean Breen <101327931+sean-breen@users.noreply.github.com>
vepatel
reviewed
Jun 5, 2026
vepatel
reviewed
Jun 5, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Proposed changes
docs: revamp README for user friendliness
Checklist
Before creating a PR, run through this checklist and mark each as complete.