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 links in documentation and add linkcheck to documentation #20030

Merged
merged 6 commits into from
Nov 4, 2021

Conversation

pcmoritz
Copy link
Contributor

@pcmoritz pcmoritz commented Nov 3, 2021

Why are these changes needed?

This fixes the broken links in our documentation and adds instructions on how to run the link checker for automatically checking if links are alive. The link checker is a bit brittle (it can for example get rate limited by github) and slow and produces a number of false positives so we are not adding it to the CI.

Related issue number

Checks

  • I've run scripts/format.sh to lint the changes in this PR.
  • I've included any doc changes needed for https://docs.ray.io/en/master/.
  • I've made sure the tests are passing. Note that there might be a few flaky tests, see the recent failures at https://flakey-tests.ray.io/
  • Testing Strategy
    • Unit tests
    • Release tests
    • This PR is not tested :(

@pcmoritz pcmoritz changed the title [docs] Add check for broken links in documentation [docs] Fix broken links in documentation and add linkcheck to documentation Nov 3, 2021
@pcmoritz
Copy link
Contributor Author

pcmoritz commented Nov 3, 2021

This fixes almost all the broken links. The only ones I didn't know how to fix is https://docs.ray.io/en/master/iter.html (MLDataset is gone?), https://ala2017.it.nuigalway.ie/papers/ALA2017_Gupta.pdf (paper gone?), https://staroid.com/settings/accesstokens (service unavailable).

@richardliaw How to fix https://docs.ray.io/en/master/iter.html?

Signed-off-by: Richard Liaw <[email protected]>
@richardliaw richardliaw merged commit a64e32c into ray-project:master Nov 4, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants