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

Fix broken links and add linkcheck back to CI #285

Merged
merged 2 commits into from
Oct 25, 2024

Conversation

wihobbs
Copy link
Member

@wihobbs wihobbs commented Oct 23, 2024

Problem: there are some broken links in our docs.

Fix them.

@wihobbs wihobbs marked this pull request as draft October 23, 2024 23:22
jameshcorbett
jameshcorbett previously approved these changes Oct 23, 2024
Copy link
Member

@jameshcorbett jameshcorbett left a comment

Choose a reason for hiding this comment

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

Looks reasonable, there are two links that just need to be changed I think rather than removed.

jobs/batch.rst Show resolved Hide resolved
@jameshcorbett
Copy link
Member

Oh sorry didn't see this was a draft :|

@wihobbs
Copy link
Member Author

wihobbs commented Oct 23, 2024

eh maybe it doesn't have to be. I'd like to get back to automating linkcheck with CI but maybe we can accomplish that in a separate pr? Thoughts, @jameshcorbett?

@jameshcorbett
Copy link
Member

jameshcorbett commented Oct 23, 2024

It depends on how much work there is to be done. If you think you could do it without a ton more effort that would be nice, because the proper way to review this PR as it is now would be to manually verify that all the links work which can be tedious.

@wihobbs wihobbs force-pushed the links branch 3 times, most recently from 4254009 to 8ab9b98 Compare October 24, 2024 23:30
Problem: there are a lot of broken links in our docs.

Fix them.
Problem: our links have become stale due to not
enforcing sphinx's linkcheck option in CI.

Add that back in.

Fixes flux-framework#284
@wihobbs wihobbs marked this pull request as ready for review October 24, 2024 23:40
@wihobbs wihobbs requested a review from jameshcorbett October 24, 2024 23:40
@wihobbs wihobbs changed the title docs: fix broken links Fix broken links and add linkcheck back to CI Oct 24, 2024
Copy link
Member

@jameshcorbett jameshcorbett left a comment

Choose a reason for hiding this comment

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

💯

@wihobbs
Copy link
Member Author

wihobbs commented Oct 25, 2024

Thanks @jameshcorbett! I'll set MWP.

@wihobbs wihobbs added the merge-when-passing mark PR for auto-merging by mergify.io bot label Oct 25, 2024
@mergify mergify bot merged commit 49a7b2a into flux-framework:master Oct 25, 2024
7 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
merge-when-passing mark PR for auto-merging by mergify.io bot
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants