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 linter to the markdown docs #2178

Closed
dgrisonnet opened this issue Aug 29, 2023 · 2 comments · Fixed by #2184
Closed

Add linter to the markdown docs #2178

dgrisonnet opened this issue Aug 29, 2023 · 2 comments · Fixed by #2184
Assignees
Labels
help wanted Denotes an issue that needs help from a contributor. Must meet "help wanted" guidelines. kind/cleanup Categorizes issue or PR as related to cleaning up code, process, or technical debt. triage/accepted Indicates an issue or PR is ready to be actively worked on.

Comments

@dgrisonnet
Copy link
Member

The markdown docs have for a long time been unstructured. Recently, they were linted in #1988 via a vscode plugin, but in order to make sure that a format sticks, we need to automate the linting process.

The goals is to have two things:

  1. Automated verification in the Makefile and in CI
  2. Automated update in the Makefile
@dgrisonnet dgrisonnet added help wanted Denotes an issue that needs help from a contributor. Must meet "help wanted" guidelines. kind/cleanup Categorizes issue or PR as related to cleaning up code, process, or technical debt. labels Aug 29, 2023
@k8s-ci-robot k8s-ci-robot added the needs-triage Indicates an issue or PR lacks a `triage/foo` label and requires one. label Aug 29, 2023
@opeco17
Copy link
Contributor

opeco17 commented Sep 2, 2023

I've created PR to introduce markdownlint-cli2.
Since some rules can't be fixed by the formatter automatically, we can create another issue and PR to fix them separately.

@dgrisonnet
Copy link
Member Author

/triage accepted
/assign @opeco17

@k8s-ci-robot k8s-ci-robot added triage/accepted Indicates an issue or PR is ready to be actively worked on. and removed needs-triage Indicates an issue or PR lacks a `triage/foo` label and requires one. labels Sep 7, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
help wanted Denotes an issue that needs help from a contributor. Must meet "help wanted" guidelines. kind/cleanup Categorizes issue or PR as related to cleaning up code, process, or technical debt. triage/accepted Indicates an issue or PR is ready to be actively worked on.
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants