-
Notifications
You must be signed in to change notification settings - Fork 35.7k
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
doc: Add markdownlint rules & apply formatting #16901
Conversation
-0, I think this is a little unnecessary |
The following sections might be updated with supplementary metadata relevant to reviewers and maintainers. ConflictsReviewers, this pull request conflicts with the following ones:
If you consider this pull request important, please also help to review the conflicting pull requests. Ideally, start with the one that should be merged first. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks. However I'm also ~0 on this. While I agree in general that it'd nice to have consistent formatting etc throughout the documentation. Going as far as someone needing to known the markdown "rules" before they can actually write any docs doesn't seem ideal.
I'm also a bit confused, because it looks like even with the reformatting & linting, there is still inconsistency? i.e using ============
and ###
variants for headers. As well as code blocks and indentation for inline code. Is this meant to be the case?
Will wait for other opinions.
This linter could be added to Travis CI, failing if it generates any output.
Definitely NACK on this. To be honest it's bad enough that test runs for new PRs can sometimes be blocked with whitespace issues. I don't really want them to be blocked because someone forgot to add a #
to a doc header or similar.
If npm is a concerning dependency
I don't really want us to be relying on or installing npm
for anything.
.markdownlint.yml automatically offers warnings in VSCode
We don't really pick/support any particular editor. I'm not sure what the VSCode usage (specifically for writing markdown?) is like among contributors; but I'd guess it's not very large (could be wrong).
The code blocks can be made both ways, correct. Thanks for the feedback on Travis. I thought about it all a bit more, and would be happy to omit Two other notes:
|
I am fine on adding the yml file, but NACK on enforcing anything or reformatting existing code. We have |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Concept ACK on improving markdown.
I also don't mind the markdown linter.
Completely agree with this. Tend toward NACK. I'd like to encourage people to focus on writing meaningful (and correct) documentation, not how to massage whitespace and formatting to make the linter happy. TBH there's too much of these PRs messing-around with whitespace and formatting rules lately. This strays very far from the intent of the project. |
I also tend to NACK on this for the stated reasons. Mild code style enforcement is acceptable. Building a too strict environment leads to wasted resources though. |
I hear the overall NACK. The intent is to have consistent, readable docs - thats all. |
822e1c3
to
aa899e7
Compare
aa899e7
to
375c11c
Compare
375c11c
to
147dfb4
Compare
Closing this, there seem to be no agreement to do this. |
This PR introduces a rules file called
.markdownlint.yml
, and a sizeable amount of documentation formatting from having applied these rules..markdownlint.yml
can be used by running npm packagemarkdownlint
from the repo root. In this case, I ran:A few advantages come from adding this linter:
.markdownlint.yml
automatically offers warnings in VSCode if pluginmarkdownlint
installed.