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: Anchor link checker #15624

Merged
merged 9 commits into from
Jan 8, 2024
Merged

docs: Anchor link checker #15624

merged 9 commits into from
Jan 8, 2024

Conversation

vtlim
Copy link
Member

@vtlim vtlim commented Jan 4, 2024

Follows up from #15621

  • Restores script that checks anchor links
  • Calls the script in GitHub Actions
  • Fixes a few more links

website/script/link-lint.js Fixed Show resolved Hide resolved
@317brian
Copy link
Contributor

317brian commented Jan 4, 2024

For context, what will happen now is that the CI will fail early if Docusaurus cannot build the site because of broken Markdown links between pages. If that passes, the updated script in this PR will also check the anchors (something that docusaurus doesn't do) and will fail if a link to a heading/anchor doesn't exist.

@317brian
Copy link
Contributor

317brian commented Jan 4, 2024

@vtlim it looks like it's getting built twice:
image

@abhishekrb19 abhishekrb19 added the Area - GitHub Actions Any GitHub Action change label Jan 4, 2024
Copy link
Contributor

@317brian 317brian 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 put in a fake header locally and ran the script:

image

One minor suggestion unrelated to what you added for this PR.

vtlim and others added 2 commits January 8, 2024 10:16
Co-authored-by: 317brian <53799971+317brian@users.noreply.github.com>
@317brian 317brian merged commit 52313c5 into apache:master Jan 8, 2024
83 checks passed
@vtlim vtlim deleted the docs-link-check branch January 8, 2024 23:38
@LakshSingla LakshSingla added this to the 29.0.0 milestone Jan 29, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants