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

fix: check markdown grammar issues #665

Merged
merged 11 commits into from
Jun 23, 2022
Merged

fix: check markdown grammar issues #665

merged 11 commits into from
Jun 23, 2022

Conversation

leemos-xx
Copy link
Member

What this PR does:
让CI自动检查markdown的语法,目前使用markdownlint来实现,考虑到贡献者体验和已知的因格式原因导致的渲染问题,现在仅开放对MD031 - Fenced code blocks should be surrounded by blank lines规则的校验,后续可以视情况逐步放开。

Which issue(s) this PR fixes:
Fixes #622

@mosn-community-bot mosn-community-bot bot added bug Something isn't working cla:yes size/XL labels Jun 22, 2022
@codecov
Copy link

codecov bot commented Jun 22, 2022

Codecov Report

Merging #665 (ae6e798) into main (0ecca3a) will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff           @@
##             main     #665   +/-   ##
=======================================
  Coverage   60.93%   60.93%           
=======================================
  Files         120      120           
  Lines        6384     6384           
=======================================
  Hits         3890     3890           
  Misses       2121     2121           
  Partials      373      373           

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 6247923...ae6e798. Read the comment docs.

@seeflood seeflood requested a review from Xunzhuo June 22, 2022 14:37
@seeflood
Copy link
Member

seeflood commented Jun 22, 2022

Looks good to me overall. Thanks !

@leemos-xx How about adding rules MD01,MD037 and MD038 ?
I added a column in your tencent doc https://docs.qq.com/sheet/DRGpJb1Ntc3hYVmh0?tab=BB08J2 marking "whether it might affect docsify", and I think MD01,MD037 and MD038 are useful too:
image

@seeflood seeflood closed this Jun 22, 2022
@seeflood seeflood reopened this Jun 22, 2022
@leemos-xx
Copy link
Member Author

Ok, I have added the check for MD001, MD037 and MD038.

@seeflood
Copy link
Member

seeflood commented Jun 23, 2022

Review process:

  • check the render result of docsify
  • modify the template of proto doc
  • fix docs/zh/start/faas/start.md

docs/zh/start/faas/start.md Outdated Show resolved Hide resolved
Copy link
Member

@seeflood seeflood left a comment

Choose a reason for hiding this comment

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

lgtm.
@Xunzhuo Could u help review this PR?

@Xunzhuo
Copy link
Member

Xunzhuo commented Jun 23, 2022

LGTM, thanks @leemos-xx

@seeflood seeflood merged commit f2039bf into mosn:main Jun 23, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working cla:yes size/XL
Projects
None yet
Development

Successfully merging this pull request may close these issues.

ci: check markdown grammar issues; 让CI自动检查markdown语法错误
3 participants