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.

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

docs-fix-broken-url #2585

Merged
merged 2 commits into from
Sep 23, 2024
Merged

docs-fix-broken-url #2585

merged 2 commits into from
Sep 23, 2024

Conversation

nginx-aoife
Copy link
Contributor

@nginx-aoife nginx-aoife commented Sep 20, 2024

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.

  • I have read the CONTRIBUTING doc
  • I have added tests that prove my fix is effective or that my feature works
  • I have checked that all unit tests pass after adding my changes
  • I have updated necessary documentation
  • 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

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-aoife nginx-aoife requested review from a team as code owners September 20, 2024 15:24
Copy link

nginx-bot bot commented Sep 20, 2024

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.

@nginx-bot nginx-bot bot added the community label Sep 20, 2024
@github-actions github-actions bot added the documentation Improvements or additions to documentation label Sep 20, 2024
Copy link

codecov bot commented Sep 20, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

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

Additional details and impacted files
@@           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           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@kate-osborn
Copy link
Contributor

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!

@ADubhlaoich ADubhlaoich merged commit 42994cb into nginxinc:main Sep 23, 2024
40 checks passed
bjee19 pushed a commit to bjee19/nginx-gateway-fabric that referenced this pull request Sep 23, 2024
bjee19 added a commit that referenced this pull request Sep 23, 2024
cherry pick docs-fix-broken-url (#2585)

Co-authored-by: nginx-aoife <50101789+nginx-aoife@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
community documentation Improvements or additions to documentation
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

4 participants