Skip to content
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.

Sign up for GitHub

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

Jump to bottom

docs: ref - relref consistency #338

Merged
merged 3 commits into from
Apr 1, 2025
Merged

docs: ref - relref consistency #338

merged 3 commits into from
Apr 1, 2025

Conversation

JTorreG
Copy link
Contributor

@JTorreG JTorreG commented Mar 31, 2025

Proposed changes

Ref link consistency:

  • non-relative links use the ref shortcode
  • relative links use the relref shortcode
  • some extra spacing removed
  • some "vague" relative links (Directly referencing a doc without relative or absolute path) replaced with absolute path equivalent links

Build does not show any broken links. Spot check done for the less common (not straightforward "/path" links) replacements

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. ↩

@JTorreG JTorreG marked this pull request as ready for review March 31, 2025 15:02
@JTorreG JTorreG requested review from a team as code owners March 31, 2025 15:02
@github-actions github-actions bot added documentation Improvements or additions to documentation product/nim NGINX Instance Manager product/nginx-plus NGINX Plus (and NGINX Open Source in docs.ngninx.com) product/ngf Issues related to NGINX Gateway Fabric product/nginx-one NGINX One Console product/nginxaas NGINX as a Service for Azure product/agent NGINX Agent tooling Back end, repository, Hugo, and all things not related to content process documentation Documentation related to how the repository or documention itself is managed. product/amplify NGINX Amplify (EOS product) product/controller NGINX Controller (EOS product) product/mesh NGINX Service Mesh (EOS product) product/modsec-waf Modsecurity-WAF (EOS product) product/nap-dos NGINX App Protect DOS product/nap-waf NGINX App Protect WAF product/nms NGINX Management Suite (EOS product) labels Mar 31, 2025
@github-actions 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/338/

@JTorreG JTorreG merged commit ce7670e into main Apr 1, 2025
8 checks passed
@JTorreG JTorreG deleted the relref-to-ref branch April 1, 2025 11:05
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@ADubhlaoich ADubhlaoich

@nginx-jack nginx-jack

Assignees
No one assigned
Labels
documentation Improvements or additions to documentation process documentation Documentation related to how the repository or documention itself is managed. product/agent NGINX Agent product/amplify NGINX Amplify (EOS product) product/controller NGINX Controller (EOS product) product/mesh NGINX Service Mesh (EOS product) product/modsec-waf Modsecurity-WAF (EOS product) product/nap-dos NGINX App Protect DOS product/nap-waf NGINX App Protect WAF product/ngf Issues related to NGINX Gateway Fabric product/nginx-one NGINX One Console product/nginx-plus NGINX Plus (and NGINX Open Source in docs.ngninx.com) product/nginxaas NGINX as a Service for Azure product/nim NGINX Instance Manager product/nms NGINX Management Suite (EOS product) tooling Back end, repository, Hugo, and all things not related to content
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@JTorreG @ADubhlaoich @nginx-jack