Skip to content

Conversation

ADubhlaoich
Copy link
Contributor

Proposed changes

These commits add a small note near the prerequisites part of a few installation-based sections of the documentation to draw the reader's attention towards the fact that documentation applies only to the latest release for NGINX Ingress Controller.

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

These commits add a small note near the prerequisites part of a few
installation-based sections of the documentation to draw the reader's
attention towards the fact that documentation applies only to the latest
release for NGINX Ingress Controller.
@ADubhlaoich ADubhlaoich requested a review from a team as a code owner July 12, 2023 11:08
@github-actions
Copy link
Contributor

github-actions bot commented Jul 12, 2023

Dependency Review

✅ No vulnerabilities or license issues found.

Scanned Manifest Files

@github-actions github-actions bot added the documentation Pull requests/issues for documentation label Jul 12, 2023
@codecov
Copy link

codecov bot commented Jul 12, 2023

Codecov Report

Merging #4093 (babc5d3) into main (a6aa714) will decrease coverage by 0.04%.
The diff coverage is n/a.

@@            Coverage Diff             @@
##             main    #4093      +/-   ##
==========================================
- Coverage   51.88%   51.84%   -0.04%     
==========================================
  Files          59       59              
  Lines       16710    16710              
==========================================
- Hits         8670     8664       -6     
- Misses       7743     7747       +4     
- Partials      297      299       +2     

see 2 files with indirect coverage changes

📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more

@brianehlert
Copy link
Collaborator

brianehlert commented Jul 12, 2023

@ADubhlaoich
Is this to add a disclaimer to main as opposed to making folks aware that the URL is release sensitive?

I ask because it reads like a disclaimer, rather than noting that the URL is release version sensitive. <- which I think is a more instructive way to address the problem.

I assume that we have some feedback that main is being used to reference documents while using some older release. You can DM me any details of the reasoning.

@lucacome
Copy link

we also don't have a way to point people to a different version of the docs if they're not using the latest release, so this might be confusing.

@shaun-nx shaun-nx merged commit fd7fc2b into main Jul 17, 2023
@shaun-nx shaun-nx deleted the docs/version-notice branch July 17, 2023 10:45
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Pull requests/issues for documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

6 participants