-
Notifications
You must be signed in to change notification settings - Fork 9.1k
Improve Markdown linting and use it on more files #4515
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
Conversation
The It also calls
|
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.
Good direction, let's just remove mdv
everywhere.
Good catch on the dependencies! Using |
18d0f0a
to
d301477
Compare
Hmm. Those GitHub workflows seem to check the old versions (which should be immutable!), this work is to improve the standards for the in-progress spec versions on the two dev branches, and all |
use markdownlint-cli2 and refresh package-lock.json
That would be my way forward. I've sketched what I'd do in @lornajane The above mentioned PR is in your repo and will update this PR's head branch. Feel free to review, merge (in your repo), do something similar in your head branch, ... 😎 |
Remove mdv from workflow
Thanks @ralfhandl , I merged your changes (with a minor edit so we only validate and don't fix in the workflow), could you take another look please? |
Note: changed branch protection rule for The same change will be needed for other branch protection rules. |
Fixes #4249 which asks for Markdown linting to be applied to the markdown files at the root level of the repo.
Points to look for:
mdv
, it is outdated and we can do most of what's needed with markdownlint. My only concern is that we're missing some formatting of json/yaml/abnf code examples, so we should consider any options on that (and be careful with them in the meantime!)sed
manouvre to fix it. I don't think the benefits of using prettier are worth having this sort of hackery in the project so we'll use the markdownlint "fix" feature instead and I removed the script.I realise that
src/oas.md
isn't present on this branch but the same configuration seemed to be okay with what's currently on bothv3.1-dev
andv3.2-dev
.