-
Notifications
You must be signed in to change notification settings - Fork 688
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 script for running markdownlint locally #1425
Conversation
note that I created a file mdlint.json that matches what is described as what we use in docs-cn
Hi Greg, I have no expertise in this area, so I'm gonna ask some pretty simple questions. Can you explain a little more about why we need to run markdownlint locally (since we already have the markdownlint CI check in the docs repo) and what has changed or what we do exactly after using the script you gave? @gregwebs |
@yikeke you don't need to run it locally. You can wait for the CI if you like. This is also stated in the new CONTRIBUTING.md file. |
@cofyc this is for running locally, not CI. But I changed both to install a specific version and the script will remove the package-lock.json if it created it. |
Yeah saw it. Thanks~ This could be helpful! |
The original script that added markdown lint check into CI was given by @aylei in #1406. Also in docs-cn: pingcap/docs-cn#1494. (See Jira Issue) Please take a look at the change proposed by Greg, thanks~ @aylei |
Co-Authored-By: Keke Yi <40977455+yikeke@users.noreply.github.com>
some linter errors are showing up in other files now, but I don't know why: I would have expected it to show up on the prior commit also. |
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.
LGTM
note that I created a file mdlint.json that matches what is described as
what we use in docs-cn
Also use that configuration in the CI