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.

Sign up for GitHub

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

Jump to bottom

[Doc] Fix the linkcheck CI job #41598

Merged
merged 7 commits into from
Dec 9, 2023
Merged

[Doc] Fix the linkcheck CI job #41598

merged 7 commits into from
Dec 9, 2023

Conversation

peytondmurray
Copy link
Contributor

@peytondmurray peytondmurray commented Dec 4, 2023 •
edited
Loading

Why are these changes needed?

  • This PR fixes the linkcheck job by bypassing ci.sh, and using a docker container on the buildkite runner.
  • This PR also fixes a ton of broken links that were causing linkcheck to fail (even without rate limit issues), mostly by removing links to examples that were deleted.
  • I also removed the global depends_on in lint.rayci.yml; not all lint jobs require the same environment.

Related issue number

Closes #41136.

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 force-pushed the fix-linkcheck branch 2 times, most recently from 77f29e7 to 960c4e3 Compare December 5, 2023 21:33
@can-anyscale can-anyscale mentioned this pull request Dec 6, 2023
Merged
@can-anyscale
Copy link
Collaborator

To delete the pipeline.test.yaml

can-anyscale added a commit to ray-project/rayci that referenced this pull request Dec 6, 2023
@can-anyscale
[ci] bye pipeline.test.yaml (#143)
80a106b 
pipeline.test.yaml will be deleted in
ray-project/ray#41598. The only thing that this
pipeline right now is the LinkCheck, which is also fixed and moved to
civ2 in the mentioned PR.

Test:
- CI

Signed-off-by: can <can@anyscale.com>
@peytondmurray peytondmurray force-pushed the fix-linkcheck branch 3 times, most recently from a8c871c to f719699 Compare December 8, 2023 17:49
@peytondmurray peytondmurray force-pushed the fix-linkcheck branch 2 times, most recently from 990847a to b812bc9 Compare December 8, 2023 19:47
@peytondmurray
[Doc] Fix the linkcheck CI job
62a6bdb 
Signed-off-by: pdmurray <peynmurray@gmail.com>
@peytondmurray peytondmurray marked this pull request as ready for review December 8, 2023 23:10
@peytondmurray peytondmurray changed the title [WIP] [Doc] Fix the linkcheck CI job [Doc] Fix the linkcheck CI job Dec 8, 2023
architkulkarni
architkulkarni approved these changes Dec 8, 2023
View reviewed changes
Copy link
Contributor

@architkulkarni architkulkarni left a comment

Choose a reason for hiding this comment

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

Thanks for doing this! kubernetes change looks good

angelinalg
angelinalg approved these changes Dec 8, 2023
View reviewed changes
doc/source/ray-contribute/docs.ipynb Outdated Show resolved Hide resolved
doc/source/ray-contribute/docs.ipynb Outdated Show resolved Hide resolved
doc/source/ray-overview/ray-libraries.rst Outdated Show resolved Hide resolved
doc/source/ray-overview/ray-libraries.rst Outdated Show resolved Hide resolved
doc/source/rllib/rllib-concepts.rst Outdated Show resolved Hide resolved
doc/source/rllib/rllib-dev.rst Outdated Show resolved Hide resolved
@peytondmurray @angelinalg
Update doc/source/ray-contribute/docs.ipynb
289016d 
Co-authored-by: angelinalg <122562471+angelinalg@users.noreply.github.com>
Signed-off-by: Peyton Murray <peynmurray@gmail.com>
peytondmurray and others added 4 commits December 8, 2023 15:43
@peytondmurray @angelinalg
Update doc/source/ray-contribute/docs.ipynb
11b04d6 
Co-authored-by: angelinalg <122562471+angelinalg@users.noreply.github.com>
Signed-off-by: Peyton Murray <peynmurray@gmail.com>
@peytondmurray @angelinalg
Update doc/source/ray-overview/ray-libraries.rst
9f2be6d 
Co-authored-by: angelinalg <122562471+angelinalg@users.noreply.github.com>
Signed-off-by: Peyton Murray <peynmurray@gmail.com>
@peytondmurray @angelinalg
Update doc/source/ray-overview/ray-libraries.rst
0ebe404 
Co-authored-by: angelinalg <122562471+angelinalg@users.noreply.github.com>
Signed-off-by: Peyton Murray <peynmurray@gmail.com>
@peytondmurray @angelinalg
Update doc/source/rllib/rllib-concepts.rst
161aa0f 
Co-authored-by: angelinalg <122562471+angelinalg@users.noreply.github.com>
Signed-off-by: Peyton Murray <peynmurray@gmail.com>
can-anyscale
can-anyscale approved these changes Dec 9, 2023
View reviewed changes
Copy link
Collaborator

@can-anyscale can-anyscale left a comment

Choose a reason for hiding this comment

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

ci change looks good!

.buildkite/build.rayci.yml Outdated Show resolved Hide resolved
@peytondmurray @angelinalg
Update doc/source/rllib/rllib-dev.rst
d2c3c47 
Co-authored-by: angelinalg <122562471+angelinalg@users.noreply.github.com>
Signed-off-by: Peyton Murray <peynmurray@gmail.com>
ArturNiederfahrenhorst
ArturNiederfahrenhorst approved these changes Dec 9, 2023
View reviewed changes
Copy link
Contributor

@ArturNiederfahrenhorst ArturNiederfahrenhorst left a comment

Choose a reason for hiding this comment

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

lgtm. I checked the RLlib related changes.

@peytondmurray
Copy link
Contributor Author

RTD looks like it failed here, but if you click on the link it looks like the docs built successfully :/. It also clearly didn't reach the 1h time limit, not sure what's happening here. cc @angelinalg I know you've seen this before as well.

@can-anyscale can-anyscale merged commit bacb0a8 into ray-project:master Dec 9, 2023
9 of 14 checks passed
@peytondmurray peytondmurray deleted the fix-linkcheck branch December 9, 2023 02:13
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@aslonnie aslonnie aslonnie left review comments

@can-anyscale can-anyscale can-anyscale approved these changes

@angelinalg angelinalg angelinalg approved these changes

@ArturNiederfahrenhorst ArturNiederfahrenhorst ArturNiederfahrenhorst approved these changes

@architkulkarni architkulkarni architkulkarni approved these changes

@maxpumperla maxpumperla Awaiting requested review from maxpumperla maxpumperla is a code owner

@pcmoritz pcmoritz Awaiting requested review from pcmoritz pcmoritz is a code owner

@kevin85421 kevin85421 Awaiting requested review from kevin85421 kevin85421 is a code owner

@sven1977 sven1977 Awaiting requested review from sven1977 sven1977 is a code owner

@avnishn avnishn Awaiting requested review from avnishn

@smorad smorad Awaiting requested review from smorad

@kouroshHakha kouroshHakha Awaiting requested review from kouroshHakha

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

[docs infra] Linkcheck failures are noisy and hurt dev productivity
6 participants
@peytondmurray @can-anyscale @architkulkarni @ArturNiederfahrenhorst @aslonnie @angelinalg