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

Fix docs links in notes #1158

Merged
merged 3 commits into from
Oct 19, 2023
Merged

Fix docs links in notes #1158

merged 3 commits into from
Oct 19, 2023

Conversation

sjberman
Copy link
Contributor

Problem: Internal docs links within notes aren't working properly.

Solution: Adjusted these links so they redirect properly.

Closes #1150

  • 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

Problem: Internal docs links within notes aren't working properly.

Solution: Adjusted these links so they redirect properly.
@sjberman sjberman requested a review from a team as a code owner October 18, 2023 21:38
@github-actions github-actions bot added the documentation Improvements or additions to documentation label Oct 18, 2023
@bjee19
Copy link
Contributor

bjee19 commented Oct 18, 2023

@bjee19
Copy link
Contributor

bjee19 commented Oct 18, 2023

Lastly, do you think we need to do anything with Github support to prevent this in the future / be able to have internal links work properly or do we just need to adjust how we implement internal links in Note/Quotes.

@sjberman
Copy link
Contributor Author

@bjee19 Internal links can be weird regardless, so I think we just need to pay close attention to whether or not our links work. Hopefully something comes out of the discussion linked in the ticket though.

@sjberman sjberman enabled auto-merge (squash) October 19, 2023 14:10
@sjberman sjberman merged commit f20fe55 into nginxinc:main Oct 19, 2023
21 checks passed
@sjberman sjberman deleted the docs/readme-links branch October 19, 2023 14:19
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

Fix internal links in READMEs
4 participants