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

markdown linting #22

Closed
olix0r opened this issue Apr 27, 2020 · 3 comments
Closed

markdown linting #22

olix0r opened this issue Apr 27, 2020 · 3 comments
Assignees
@kleimkuhler

Comments

@olix0r
Copy link
Member

olix0r commented Apr 27, 2020

Wanted: a markdown-linting script that enforce consistent document formatting. Should be a merge-check and a tool that can be run manually to check/fix.

Also, I think we should ideally enforce an 80 char wrap...
@admc
Copy link
Contributor

admc commented Apr 28, 2020

Maybe https://github.com/marketplace/actions/markdown-linting-action will do what we want?

@kleimkuhler kleimkuhler mentioned this issue May 15, 2020
Merged
kleimkuhler added a commit to linkerd/linkerd2 that referenced this issue May 20, 2020
@kleimkuhler
Lint all markdown files in CI (#4402)
d99c148 
## Motivation

linkerd/rfc#22

## Solution

Use the [markdown-lint-action](https://github.com/marketplace/actions/markdown-linting-action) to lint all `.md` files for all pull requests
and pushes to master.

This action uses the default rules outlined in [markdownlint
package](https://github.com/DavidAnson/markdownlint/blob/master/doc/Rules.md).

The additional rules are added are explained below:
- Ignore line length lints for code blocks
- Ignore line length lints for tables
- Allow duplicate sub-headers in sibling headers (e.g. allowing multiple ##
  Significant headers in `CHANGES.md` as long as they are part of separate
  release headers)

Signed-off-by: Kevin Leimkuhler <kevin@kleimkuhler.com>
@ihcsim
Copy link

ihcsim commented Jul 13, 2020

@kleimkuhler Is there anything else left on this one?

@kleimkuhler
Copy link
Collaborator

@ihcsim Nope! This was covered in linkerd/linkerd2#4402 and #28

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@kleimkuhler kleimkuhler

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
4 participants
@admc @olix0r @ihcsim @kleimkuhler