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

[Doc] Fix broken links in train documentation #44953

Merged

Conversation

peytondmurray
Copy link
Contributor

Why are these changes needed?

This PR fixes a few broken links in the train library and documentation.

Related issue number

Partially addresses #39658.

@matthewdeng @justinvyu Before merging this, the benchmark_example.rst is totally orphaned at the moment. It's not part of any example gallery, and there's no real way for people to find it on our docs. What should we do about that?

Checks

  • I've signed off every commit(by using the -s flag, i.e., git commit -s) in this PR.
  • 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 added any new APIs to the API Reference. For example, if I added a
      method in Tune, I've added it in doc/source/tune/api/ under the
      corresponding .rst file.
  • 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 :(

@peytondmurray peytondmurray added the docs An issue or change related to documentation label Apr 24, 2024
@matthewdeng
Copy link
Contributor

@peytondmurray we can go ahead and remove benchmark_example.rst! Thanks!

Signed-off-by: pdmurray <peynmurray@gmail.com>
@peytondmurray
Copy link
Contributor Author

Removed. Should be good to merge once docs build+tests pass.

Copy link
Collaborator

@aslonnie aslonnie left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

approved for docs, but @matthewdeng leaving this PR to you.

@anyscalesam anyscalesam added the triage Needs triage (eg: priority, bug/not-bug, and owning component) label Apr 26, 2024
Copy link
Contributor

@matthewdeng matthewdeng left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ty!

@matthewdeng matthewdeng merged commit 63cd1ac into ray-project:master Apr 29, 2024
5 checks passed
@peytondmurray peytondmurray deleted the docs-fix-train-bad-links-39658 branch April 29, 2024 21:24
harborn pushed a commit to harborn/ray that referenced this pull request May 8, 2024
Signed-off-by: pdmurray <peynmurray@gmail.com>
ryanaoleary pushed a commit to ryanaoleary/ray that referenced this pull request Jun 7, 2024
Signed-off-by: pdmurray <peynmurray@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs An issue or change related to documentation triage Needs triage (eg: priority, bug/not-bug, and owning component)
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

5 participants