Update READMEs #3788
Merged
Update READMEs #3788
+3
−117
Conversation
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
Problem: The helm chart README contained a section that is outdated and removed from our official docs. Also, our main README contains some misleading language around supporting a subset of the Gateway API. While we technically do support a subset, the language makes it sound like our intention is to support a subset, which isn't really true and sounds worse than it is. Solution: Remove the unneeded sections from both READMEs.
github-actions
bot
added
documentation
|
why are we removing all information about zero downtime upgrades ( its not outdated? ) - or just trying to specify it in docs ? |
|
That process isn't relevant anymore after the control/data plane split. Previously, the data plane would be torn down as part of the control plane upgrade. Now, with readiness probes and the separation, the process is smoother. |
|
so will we remove this section from officials docs too ?
|
|
That doc is different, that's focused on upgrading user apps, not nginx/NGF. |
salonichf5
approved these changes
Aug 25, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.
Problem: The helm chart README contained a section that is outdated and removed from our official docs. Also, our main README contains some misleading language around supporting a subset of the Gateway API. While we technically do support a subset, the language makes it sound like our intention is to support a subset, which isn't really true and sounds worse than it is.
Solution: Remove the unneeded sections from both READMEs.
Checklist
Before creating a PR, run through this checklist and mark each as complete.
Release notes
If this PR introduces a change that affects users and needs to be mentioned in the release notes,
please add a brief note that summarizes the change.