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 script for running markdownlint locally #1425

Merged
merged 11 commits into from
Aug 15, 2019

Conversation

gregwebs
Copy link
Contributor

@gregwebs gregwebs commented Aug 6, 2019

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

note that I created a file mdlint.json that matches what is described as
what we use in docs-cn
@gregwebs gregwebs requested review from cofyc and yikeke August 6, 2019 23:29
scripts/mdlint.json Outdated Show resolved Hide resolved
.gitignore Outdated Show resolved Hide resolved
@yikeke yikeke requested a review from aylei August 7, 2019 02:48
@aylei aylei requested a review from YiniXu9506 August 7, 2019 04:09
package-lock.json Outdated Show resolved Hide resolved
scripts/markdownlint Outdated Show resolved Hide resolved
@yikeke
Copy link
Contributor

yikeke commented Aug 8, 2019

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

@gregwebs
Copy link
Contributor Author

gregwebs commented Aug 8, 2019

@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.

@gregwebs
Copy link
Contributor Author

gregwebs commented Aug 8, 2019

@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.

@yikeke
Copy link
Contributor

yikeke commented Aug 9, 2019

@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.

Yeah saw it. Thanks~ This could be helpful!

@yikeke
Copy link
Contributor

yikeke commented Aug 9, 2019

@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.

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

CONTRIBUTING.md Outdated Show resolved Hide resolved
Co-Authored-By: Keke Yi <40977455+yikeke@users.noreply.github.com>
@gregwebs
Copy link
Contributor Author

gregwebs commented Aug 9, 2019

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.

@yikeke yikeke self-assigned this Aug 12, 2019
Copy link
Contributor

@aylei aylei left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@yikeke yikeke merged commit c267cbe into pingcap:master Aug 15, 2019
@yikeke yikeke added the translation/doing This PR's assignee is translating this PR. label Aug 15, 2019
@yikeke yikeke assigned anotherrachel and unassigned yikeke Sep 24, 2019
@anotherrachel anotherrachel added translation/done This PR has been translated from English into Chinese and updated to pingcap/docs-cn in a PR. and removed translation/doing This PR's assignee is translating this PR. labels Sep 24, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
translation/done This PR has been translated from English into Chinese and updated to pingcap/docs-cn in a PR.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

7 participants