-
Notifications
You must be signed in to change notification settings - Fork 863
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
Updating index.md to fix 8 broken links #2329
Conversation
Update to fix a broken link in index.md where the trailing .md is cut off from the management_api.md. Added an anchor link to force the .md to show up.
Update to index.md to fix several links ending in .md that sphinx is breaking. Added anchor links to each link and a corresponding anchor in the affected doc. Tested locally and seems to be working.
Codecov Report
@@ Coverage Diff @@
## master #2329 +/- ##
=======================================
Coverage 69.39% 69.39%
=======================================
Files 77 77
Lines 3441 3441
Branches 57 57
=======================================
Hits 2388 2388
Misses 1050 1050
Partials 3 3 📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more |
It's a small thing but helpful: when we make updates to certain pages I run a spellcheck on them so they're not typos you introduced but should be fixed nonetheless https://github.com/pytorch/serve/actions/runs/4941584585/jobs/8834328240?pr=2329 so if something is a typo you can fix and if it's not a typo you can add it here https://github.com/pytorch/serve/blob/master/ts_scripts/spellcheck_conf/wordlist.txt |
Makes sense. Will update the necessary files |
Fixed typos and updated wordslist.txt
LGTM, we usually need 2 stamps on the team so almost done! |
Thanks for all the help |
Description
Please read our CONTRIBUTING.md prior to creating your first pull request.
Fixed a couple of broken links in the index.md file. Fix affected about 5 files and is a result of how syphinx handles .md files to html by dropping the .md.
Added anchor links to each link .
Type of change
Please delete options that are not relevant.
Feature/Issue validation/testing
Please describe the Unit or Integration tests that you ran to verify your changes and relevant result summary. Provide instructions so it can be reproduced.
Please also list any relevant details for your test configuration.
Built pages locally on my machine and tested the different links. Attached is a screenshot of two of the links working from the index.html file.
Checklist: