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

docs: lint Markdown #3178

Merged
merged 1 commit into from
Jan 6, 2021
Merged

docs: lint Markdown #3178

merged 1 commit into from
Jan 6, 2021

Conversation

jbampton
Copy link
Member

@jbampton jbampton commented Jan 3, 2021

Lint Markdown for rule:

  • MD022/blanks-around-headings

What this PR does / why we need it:

Standardizes the Markdown files

Pre-submission checklist:

  • Did you explain what problem does this PR solve? Or what new features have been added?
  • Have you added corresponding test cases?
  • Have you modified the corresponding document?
  • Is this PR backward compatible? If it is not backward compatible, please discuss on the mailing list first

@jbampton
Copy link
Member Author

jbampton commented Jan 3, 2021

cc @spacewander

It seems the linters are not working now.

Error message was:

ibiqlik/action-yamllint@v3 is not allowed to be used in apache/apisix. Actions in this workflow must be: created by GitHub, verified in the GitHub Marketplace, within a repository owned by apache or match the following: apache/, gradle/wrapper-validation-action, gradle/wrapper-validation-action@, peter-evans/create-pull-request@, dawidd6/action-download-artifact@, scacap/action-surefire-report@*.

@spacewander
Copy link
Member

@jbampton
The policy of Apache has changed recent day. Maybe we can run yamllint directly, just like what we have done with misspell?

find apisix doc bin t -not -path "t/toolkit/*.lua" -type f | xargs ./misspell -error

@jbampton
Copy link
Member Author

jbampton commented Jan 5, 2021

We need to wait until #3196 is merged in before we can test this PR.

After #3196 is merged I will rebase.

Lint Markdown for rule:
-  MD022/blanks-around-headings
@spacewander spacewander merged commit 7c5df5d into apache:master Jan 6, 2021
@jbampton jbampton deleted the lint-markdown branch January 6, 2021 03:49
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants