Skip to content

Update NGF documentation on how to use NginxProxy #135

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

Conversation

kate-osborn
Copy link

Proposed changes

Problem: The documentation for NGF's NginxProxy API needs to be updated now that NGF supports attaching NginxProxy resources to Gateways.

Solution: Updates the Gateway API Compatibility doc to list Gateway Infrastructure field as partially supported. Also, updates the data plane configuration how-to to describe how to attach NginxProxy resources to Gateways and GatewayClasses.

Testing: Checked the rendered documentation.

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 ensured that documentation content adheres to the style guide
  • If the change involves potentially sensitive changes, I have assessed the possible impact
  • If applicable, I have added tests that prove my fix is effective or that my feature works
  • If applicable, I have checked that any relevant tests pass after adding my changes
  • I have updated any relevant documentation (README.md and CHANGELOG.md)
  • 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

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.

Updates the Gateway API Compatibility doc to list
Gateway Infrastructure field as partially supported.
Also, updates the data plane configuration how-to to describe
how to attach NginxProxy resources to Gateways and GatewayClasses.
@kate-osborn kate-osborn requested a review from a team as a code owner January 29, 2025 16:20
@kate-osborn kate-osborn requested a review from a team January 29, 2025 16:20
@kate-osborn kate-osborn requested a review from sjberman January 29, 2025 16:33
@ADubhlaoich ADubhlaoich merged commit 4577687 into nginx:ngf-release-2.0 Jan 29, 2025
5 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants