Skip to content

feat: Clarify 3.x to 4.x upgrade process for NGINX Ingress Controller #802

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

Merged
merged 4 commits into from
Jul 10, 2025

Conversation

ADubhlaoich
Copy link
Contributor

Proposed changes

This commit renames the Upgrade to 3.x document for NGINX Ingress Controller to clarify it is for 3.x to 4.00 only. It adds an explicit warning call-out at the top of the page to reinforce this, and the Helm installation document has also been updated with more generic phrasing.

At a certain point of maturity the note on the Helm instructions page could likely be removed, unless we anticipate someone will be still be running a 3.x instance years after the versions have moved on.

Checklist

Before merging a pull request, run through this checklist and mark each as complete.

  • I have read the contributing guidelines
  • I have signed the F5 Contributor License Agreement (CLA)
  • I have rebased my branch onto main
  • I have ensured my PR is targeting the main branch and pulling from my branch from my own fork
  • I have ensured that the commit messages adhere to Conventional Commits
  • I have ensured that documentation content adheres to the style guide
  • If the change involves potentially sensitive changes1, I have assessed the possible impact
  • If applicable, I have added tests that prove my fix is effective or that my feature works
  • I have ensured that existing tests pass after adding my changes
  • If applicable, I have updated README.md

Footnotes

  1. Potentially sensitive changes include anything involving code, personally identify information (PII), live URLs or significant amounts of new or revised documentation. Please refer to our style guide for guidance about placeholder content.

This commit renames the Upgrade to 3.x document for NGINX Ingress
Controller to clarify it is for 3.x to 4.00 only. It adds an explicit
warning call-out at the top of the page to reinforce this, and the Helm
installation document has also been updated with more generic phrasing.

At a certain point of maturity the note on the Helm instructions page
could likely be removed, unless we anticipate someone will be still be
running a 3.x instance years after the versions have moved on.
@ADubhlaoich ADubhlaoich requested a review from a team as a code owner July 10, 2025 11:07
@github-actions github-actions bot added documentation Improvements or additions to documentation product/nic NGINX Ingress Controller related issues labels Jul 10, 2025
Copy link

Deploy Preview will be available once build job completes!

Name Link
😎 Deploy Preview https://frontdoor-test-docs.nginx.com/previews/docs/802/

@ADubhlaoich ADubhlaoich merged commit d1bb519 into main Jul 10, 2025
7 checks passed
@ADubhlaoich ADubhlaoich deleted the nic/clarify-upgrade-process branch July 10, 2025 13:48
lamATnginx pushed a commit that referenced this pull request Jul 15, 2025
…#802)

This commit renames the Upgrade to 3.x document for NGINX Ingress
Controller to clarify it is for 3.x to 4.0.00 only. It adds an explicit
warning call-out at the top of the page to reinforce this, and the Helm
installation document has also been updated with more generic phrasing.

At a certain point of maturity the note on the Helm instructions page
could likely be removed, unless we anticipate someone will be still be
running a 3.x instance years after the versions have moved on.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation product/nic NGINX Ingress Controller related issues
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants