Skip to content

Chore: Update README.md - #10112

Open
sean-breen wants to merge 18 commits into
mainfrom
chore/update-readme
Open

Chore: Update README.md#10112
sean-breen wants to merge 18 commits into
mainfrom
chore/update-readme

Conversation

@sean-breen

@sean-breen sean-breen commented Jun 4, 2026

Copy link
Copy Markdown
Contributor

Proposed changes

docs: revamp README for user friendliness

  • Add tagline, badges, and table of contents for easy navigation
  • Add Features section highlighting key capabilities
  • Add Quick Start section with Helm and manifest install commands
  • Add Docker Images section listing all distribution registries
  • Add LTS Releases subsection with registry links
  • Consolidate Documentation links into a summary table
  • Expand community call dates through October 2026
  • Move detailed release matrix and SBOM info into subsections

Checklist

Before creating a PR, run through this checklist and mark each as complete.

  • I have read the CONTRIBUTING doc
  • I have added tests that prove my fix is effective or that my feature works
  • I have checked that all unit tests pass after adding my changes
  • I have updated necessary documentation
  • I have rebased my branch onto main
  • I will ensure my PR is targeting the main branch and pulling from my branch from my own fork

@sean-breen
sean-breen requested a review from a team as a code owner June 4, 2026 15:58
Copilot AI review requested due to automatic review settings June 4, 2026 15:58
@github-actions github-actions Bot added the chore Pull requests for routine tasks label Jun 4, 2026

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Comment thread README.md Outdated
Comment thread README.md Outdated
Comment thread README.md Outdated
Comment thread README.md Outdated
javorszky
javorszky previously approved these changes Jun 4, 2026

@javorszky javorszky left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Comment thread README.md Outdated
sean-breen and others added 5 commits June 4, 2026 17:54
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>
Comment thread README.md
Comment thread README.md Outdated
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

chore Pull requests for routine tasks

Projects

Status: Todo ☑

Development

Successfully merging this pull request may close these issues.

4 participants