nginxinc / nginx-gateway-fabric

NGINX Gateway Fabric provides an implementation for the Gateway API using NGINX as the data plane.
Apache License 2.0
501 stars 97 forks source link

Add docs for rewrite client IP settings #2701

Closed salonichf5 closed 3 weeks ago

salonichf5 commented 3 weeks ago

Proposed changes

Write a clear and concise description that helps reviewers understand the purpose and impact of your changes. Use the following format:

Problem: User needs documentation explaining how to configure rewrite client IP settings.

Solution: Adds documentation on how to configure rewrite client IP settings

Testing: Manual testing using make watch docs.

Screenshot 2024-10-18 at 1 07 26 PM

Please focus on (optional): If you any specific areas where you would like reviewers to focus their attention or provide specific feedback, add them here.

Closes #2517

Checklist

Before creating a PR, run through this checklist and mark each as complete.

Release notes

If this PR introduces a change that affects users and needs to be mentioned in the release notes, please add a brief note that summarizes the change.

github-actions[bot] commented 3 weeks ago

Deploy Preview will be available once build job completes!

Name Link
Deploy Preview https://frontdoor-test-docs.nginx.com/previews/nginx-gateway-fabric/2701/

codecov[bot] commented 3 weeks ago

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Project coverage is 89.38%. Comparing base (88661c1) to head (8c4a0ba). Report is 1 commits behind head on main.

Additional details and impacted files ```diff @@ Coverage Diff @@ ## main #2701 +/- ## ======================================= Coverage 89.38% 89.38% ======================================= Files 110 110 Lines 10913 10913 Branches 50 50 ======================================= Hits 9755 9755 Misses 1100 1100 Partials 58 58 ```

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.