-
Notifications
You must be signed in to change notification settings - Fork 816
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
Add linting steps to doc-automation workflow #1855
Add linting steps to doc-automation workflow #1855
Conversation
Codecov Report
@@ Coverage Diff @@
## master #1855 +/- ##
=======================================
Coverage 44.95% 44.95%
=======================================
Files 63 63
Lines 2609 2609
Branches 56 56
=======================================
Hits 1173 1173
Misses 1436 1436 📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more |
Thanks @sadra-barikbin this is a good step forward, to merge this here's what's left
|
I noticed you're fixing some links, an important detail is for links in docs folder you need absolute links like a direct link GitHub.com/etc.. if you're linking to anything outside of docs otherwise the generated link will be broken. Anything that includes a .. is likely to be broken for example I realize this is a bit messy but thank you for patience, this work will save us a lot of time. |
Regarding those links, link-checker didn't raise an error. Where exactly you mean those links would break? |
Here's a good example https://github.com/pytorch/serve/pull/1794/files |
1992d57
to
a799657
Compare
I did. Some link errors need your review. |
Is spellcheck really a necessary thing? New words, sequences etc. must get added to its dictionary again and again. We could fix all typos now and remove this step. From now on, typos would most likely be fixed during PR reviews. |
0f8ad73
to
82971e4
Compare
Spellchecking is definitely lower priority than finding broken links we can finish that first |
@msaroufim any blocker? |
The Lint jobs are both red, they should be green for us to merge this specific change. Spellchecking needs to be progressive (only apply to changed files) as we discussed or not used Also should resolve the merge conflict. Let me know if you have any questions. |
ecdd985
to
59d0d29
Compare
@msaroufim , Some links need your review:
|
The last commit is about a link which due to a bug in |
Great to see the lint spellcheck now green For the links here are some answers to your specific questions
|
f52cefc
to
f11a32e
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Heroic effort thank you!
3a04eb2
to
3ac7a92
Compare
@msaroufim , This repo isn't actively maintained? |
It is, folks are just busy with other stuff @lxning @namannandan @agunapal @rohithkrn can one of you please take a look? |
@sadra-barikbin please address the last piece of feedback from @namannandan, get the spellcheck job to be green and we should be good to merge this |
Done |
* Add linting steps to doc-automation workflow * Move changes to lint.yml * Some improvements * Fix bug * Some enhancements * Fix bug * Fix some links, a few typos and also linting steps * Fix intel-extension links and some others * Fix some typos * Fix remaining typos * Fix some other links * Fix bug * Add some words to wordllist.txt * Add some other words to wordlist.txt * Fix some links and improve markdown-lin-check config * Fix bug * Temporary fix a link * Fix 4 remaining links * Fix typos * Fix typos * Fix bug * Improve spellcheck and fix misspellings * Clean wordlist.txt abit * Fix GitHub 403 errors From tcort/markdown-link-check#201 (comment) * Fix md-link-check version * Fix a link Co-authored-by: Mark Saroufim <marksaroufim@fb.com>
* Add linting steps to doc-automation workflow * Move changes to lint.yml * Some improvements * Fix bug * Some enhancements * Fix bug * Fix some links, a few typos and also linting steps * Fix intel-extension links and some others * Fix some typos * Fix remaining typos * Fix some other links * Fix bug * Add some words to wordllist.txt * Add some other words to wordlist.txt * Fix some links and improve markdown-lin-check config * Fix bug * Temporary fix a link * Fix 4 remaining links * Fix typos * Fix typos * Fix bug * Improve spellcheck and fix misspellings * Clean wordlist.txt abit * Fix GitHub 403 errors From tcort/markdown-link-check#201 (comment) * Fix md-link-check version * Fix a link Co-authored-by: Mark Saroufim <marksaroufim@fb.com>
spellcheck and linkcheck was added to workflow yml file.
Checklist: