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

docs-fix-broken-url #2585

Closed nginx-aoife closed 1 month ago

nginx-aoife commented 1 month ago

Proposed changes

Fixing a broken URL in the Documentation. https://docs.nginx.com/nginx-gateway-fabric/installation/installing-ngf/helm/

Problem: The link command-line flag in the Nginx Gateway Fabric Docs in here https://docs.nginx.com/nginx-gateway-fabric/installation/installing-ngf/helm/#access-nginx-gateway-fabric is broken. User is returned a 404 page.

Solution: I have updated the link to use the correct path reference/cli-help.md#static-mode

Testing: Describe any testing that you did.

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 #ISSUE

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.

nginx-bot[bot] commented 1 month ago

Hi @nginx-aoife!

Thanks for opening this pull request! Be sure to check out our Contributing Guidelines while you wait for someone on the team to review this.

Please make sure to include the issue number in the PR description to automatically close the issue when the PR is merged. See Linking a pull request to an issue and our Pull Request Guidelines for more information.

codecov[bot] commented 1 month ago

Codecov Report

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

Project coverage is 89.29%. Comparing base (dacb476) to head (ca4c5b6). Report is 1 commits behind head on main.

Additional details and impacted files ```diff @@ Coverage Diff @@ ## main #2585 +/- ## ======================================= Coverage 89.29% 89.29% ======================================= Files 100 100 Lines 7633 7633 Branches 50 50 ======================================= Hits 6816 6816 Misses 761 761 Partials 56 56 ```

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

kate-osborn commented 1 month ago

Hi @nginx-aoife thanks for the PR! Can you please update the PR description to use the template, and format your commit message as:

Problem: <> Solution: <>

Thank you!