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

Add broken links checker for docs to CI #751

Merged
merged 2 commits into from
Dec 23, 2024

Conversation

pfeifferj
Copy link
Contributor

@pfeifferj pfeifferj commented Dec 5, 2024

Type of change

  • Refactor
  • New feature
  • Bug fix
  • Optimization
  • Documentation Update

Description

I noticed quite a few broken links in the documentation which can be frustrating to end-users trying to find information and thought the sustainable solution for this problem would be to add a check to CI that identifies such broken links so they can be fixed properly

Related Tickets & Documents

  • Related Issue #
  • Closes #

@pfeifferj pfeifferj force-pushed the docs-broken-links-checker branch 3 times, most recently from c1cbc22 to 85d31e5 Compare December 5, 2024 09:34
@pfeifferj pfeifferj force-pushed the docs-broken-links-checker branch from 85d31e5 to c706f75 Compare December 5, 2024 09:35
@pfeifferj pfeifferj marked this pull request as ready for review December 5, 2024 09:39
@pfeifferj pfeifferj changed the title Draft: Add broken links checker for docs to CI Add broken links checker for docs to CI Dec 17, 2024
@rsevilla87 rsevilla87 self-requested a review December 23, 2024 09:01
Copy link
Member

@rsevilla87 rsevilla87 left a comment

Choose a reason for hiding this comment

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

lgtm

@rsevilla87 rsevilla87 merged commit 97f294d into kube-burner:main Dec 23, 2024
8 checks passed
@pfeifferj pfeifferj deleted the docs-broken-links-checker branch December 23, 2024 16:15
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants