Skip to content

Conversation

@ADubhlaoich
Copy link
Member

@ADubhlaoich ADubhlaoich commented Jun 20, 2025

Proposed changes

This commit updates all non-uniform NGINX Ingress Controller links to follow the standardised Hugo ref convention. This involves updating the paths of every existing ref to add the /nic/ subfolder, excising any remaining relref uses and removing Markdown-style inline links.

Outside of style uniformity, it means that broken links will now be detected by Hugo's built-in error mechanisms, making it easier to maintain link integrity. Many affected files also had small metadata or formatting changes applied to them.

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 and CHANGELOG.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 updates all non-uniform NGINX Ingress Controller links to
follow the standardised Hugo ref convention. This involves updating the
paths of every existing ref to add the /nic/ subfolder, excising any
remaining relref uses and removing Markdown-style inline links.

Outside of style uniformity, it means that broken links will now be
detected by Hugo's built-in error mechanisms, making it easier to
maintain link integrity. Many affected files also had small metadata or
formatting changes applied to them.
@ADubhlaoich ADubhlaoich requested a review from a team as a code owner June 20, 2025 10:09
@github-actions github-actions bot added the documentation Improvements or additions to documentation label Jun 20, 2025
@github-actions
Copy link

Deploy Preview will be available once build job completes!

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

Copy link
Contributor

@javorszky javorszky left a comment

Choose a reason for hiding this comment

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

Checked out branch, spun up a local copy with make watch, double checked that the links indeed go to the same local of the docs, and that the images are correctly linked and appear.

Besides the one page I can't find being linked from anywhere, it's good to go :shipit:

@javorszky javorszky requested a review from a team as a code owner June 20, 2025 12:53
@ADubhlaoich ADubhlaoich added the product/nic Issues related to NGINX Ingress Controller label Jun 20, 2025
@ADubhlaoich ADubhlaoich removed the request for review from a team June 20, 2025 13:36
@ADubhlaoich ADubhlaoich merged commit 377f265 into main Jun 20, 2025
10 checks passed
@ADubhlaoich ADubhlaoich deleted the nic/update-live-urls branch June 20, 2025 13:37
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 Issues related to NGINX Ingress Controller

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants