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

Fix documentation link check script #12423

Merged
merged 1 commit into from
Oct 30, 2024
Merged

Fix documentation link check script #12423

merged 1 commit into from
Oct 30, 2024

Conversation

nwmac
Copy link
Member

@nwmac nwmac commented Oct 30, 2024 •
edited
Loading

Summary

Fixes #12422

Occurred changes and/or fixed issues

Updates the documentation link checker to correctly parse the version number following other recent changes.

The version number was moved to version.js, so the script needs to read that too.

Also:

  1. Added more resilience, so it will fail if it does not parse this correctly.
  2. Fixed the error reporting when a link access fails
  3. Logged detected links that the check skips (those not beginning with the docsBase property)

Checklist

  • The PR is linked to an issue and the linked issue has a Milestone, or no issue is needed
  • The PR has a Milestone
  • The PR template has been filled out
  • The PR has been self reviewed
  • The PR has a reviewer assigned
  • The PR has automated tests or clear instructions for manual tests and the linked issue has appropriate QA labels, or tests are not needed
  • The PR has reviewed with UX and tested in light and dark mode, or there are no UX changes

@nwmac nwmac self-assigned this Oct 30, 2024
@nwmac nwmac added the shell PRs/Issues that relate to a shell release rather than being needed for a dashboard release label Oct 30, 2024
@rancher-ui-project-bot rancher-ui-project-bot bot added this to the v2.10.0 milestone Oct 30, 2024
@nwmac nwmac requested review from richard-cox and aalves08 October 30, 2024 13:31
@nwmac
Copy link
Member Author

nwmac commented Oct 30, 2024

Note: 2.10 doc links are now active, so this PR correctly passes the gates

@nwmac nwmac requested a review from momesgin October 30, 2024 14:36
aalves08
aalves08 approved these changes Oct 30, 2024
View reviewed changes
Copy link
Member

@aalves08 aalves08 left a comment

Choose a reason for hiding this comment

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

LGTM @nwmac

@nwmac nwmac merged commit e2731eb into rancher:master Oct 30, 2024
40 checks passed
@nwmac nwmac deleted the fix-doc-link-checker branch October 30, 2024 14:42
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@aalves08 aalves08 aalves08 approved these changes

@richard-cox richard-cox Awaiting requested review from richard-cox

@momesgin momesgin Awaiting requested review from momesgin

Assignees

@nwmac nwmac

Labels
shell PRs/Issues that relate to a shell release rather than being needed for a dashboard release
Projects
None yet
Milestone
v2.10.0
Development

Successfully merging this pull request may close these issues.

2.10 Doc links aren't in place
2 participants
@nwmac @aalves08