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

Automatically check all the markdown links #3258

Open
mlavacca opened this issue Aug 9, 2024 · 2 comments · May be fixed by #3405
Open

Automatically check all the markdown links #3258

mlavacca opened this issue Aug 9, 2024 · 2 comments · May be fixed by #3405
Assignees
Labels
good first issue Denotes an issue ready for a new contributor, according to the "help wanted" guidelines. kind/feature Categorizes issue or PR as related to a new feature. priority/backlog Higher priority than priority/awaiting-more-evidence. triage/accepted Indicates an issue or PR is ready to be actively worked on.

Comments

@mlavacca
Copy link
Member

mlavacca commented Aug 9, 2024

What would you like to be added:

We need to improve our CI to automatically check that we don't have broken links in the .md files. There are two different pieces of markdown we need to check:

  • plain .md files, such as the ones under /geps: we should check both internal and external links
  • documentation built with mkdocs: internal links are already checked by the tool; we need to check external links.

Why this is needed:

To improve our documentation robustness.

@mlavacca mlavacca added the kind/feature Categorizes issue or PR as related to a new feature. label Aug 9, 2024
@shaneutt
Copy link
Member

shaneutt commented Sep 20, 2024

/triage accepted
/priority backlog
/help

@k8s-ci-robot k8s-ci-robot added triage/accepted Indicates an issue or PR is ready to be actively worked on. priority/backlog Higher priority than priority/awaiting-more-evidence. labels Sep 20, 2024
@shaneutt shaneutt added the good first issue Denotes an issue ready for a new contributor, according to the "help wanted" guidelines. label Sep 20, 2024
@achrefothmani
Copy link

/assign

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
good first issue Denotes an issue ready for a new contributor, according to the "help wanted" guidelines. kind/feature Categorizes issue or PR as related to a new feature. priority/backlog Higher priority than priority/awaiting-more-evidence. triage/accepted Indicates an issue or PR is ready to be actively worked on.
Projects
Status: Backlog
Development

Successfully merging a pull request may close this issue.

4 participants