dev, .circleci/config.yml, .markdownlint.yaml: Add markdown style check for dev folder #1494

aylei · 2019-06-23T13:04:12Z

Signed-off-by: Aylei rayingecho@gmail.com

What is changed, added or deleted?

Add markdown style check (based on markdownlint) for dev folder and README.md.
Fix all lint errors appeared in /dev/ folder
Leave the errors in README.md unchanged in order to verify the CI check (I will fix these errors after the code review complete)

What is the related PR or file link(s)?

To close the #1463 issue.

Which version does your change affect?

It might apply to all versions.

@yikeke @CaitinChen @lilin90 PTAL

The 29 markdownlint rules that is given by Coco and implemented in this PR:

See all of the 49 markdownlint rules for details.

Signed-off-by: Aylei <rayingecho@gmail.com>

aylei · 2019-06-24T07:09:14Z

@yikeke @lilin90 markdown files that violate the rules will fail the CI check like this, PTAL

aylei · 2019-06-24T07:18:27Z

@xuechunL PTAL

yikeke · 2019-07-07T12:21:51Z

dev/benchmark/sysbench.md

@@ -30,19 +30,19 @@ IDC 机器
 | OS       | linux (CentOS 7.3.1611)       |
 | CPU | 40 vCPUs, Intel(R) Xeon(R) CPU E5-2630 v4 @ 2.20GHz |
 | RAM | 128GB |
-| DISK | 1.5T SSD * 2  + Optane SSD * 1 |
+| DISK | 1.5T SSD \* 2  + Optane SSD \* 1 |


Is "" the escape character? Why we need it here?

* sign is used to italic or bold the text in markdown, so it is recommended to use \ to escape the * sign

dev/faq/tidb.md

dev/how-to/deploy/orchestrated/ansible.md

yikeke · 2019-07-07T12:42:03Z

dev/how-to/scale/horizontally.md

-|pd1|http://host1:2379|http://host1:2380|
-|pd2|http://host2:2379|http://host2:2380|
-|pd3|http://host3:2379|http://host3:2380|
+|pd1|`http://host1:2379`|`http://host1:2380`|


我认为应该被反引号包裹, 部分页面上会把 bare URL 渲染成 hyperlink, 用户点过去是没有意义的

@aylei 不能点的链接可以加反引号，咱们文档里还有一些链接是能点的，这些我们尽量在之后的风格指南里来限定下规则，使用 <url> 或者 []()。[]() 目前有一些，是为了 fix 链接与后面紧接着的逗号和句号均被识别为 url 的一部分导致的死链。

能点的目前我都修改成了 [www.pingcap.com](www.pingcap.com) 这种形式

dev/how-to/upgrade/rolling-updates-with-ansible.md

dev/reference/configuration/pd-server/configuration.md

yikeke · 2019-07-07T12:54:41Z

@yikeke @lilin90 markdown files that violate the rules will fail the CI check like this, PTAL

Thanks so much for your work. Most of the file changes look good to me. I see that you just checked and changed the dev files, if this check finally works, we can then apply it to all other files. :)

I made some small comments, PTAL.

aylei · 2019-07-08T06:01:33Z

Note that MD014 is disabled now because not all $ signs in code blocks are eliminated now @yikeke , you can enable this rule when the change completes.

yikeke · 2019-07-08T09:28:51Z

Note that MD014 is disabled now because not all $ signs in code blocks are eliminated now @yikeke , you can enable this rule when the change completes.

Okay, thanks!

Signed-off-by: Aylei <rayingecho@gmail.com>

aylei · 2019-07-08T16:01:44Z

@yikeke I've fixed the markdownlint errors introduced by the merge along with the errors in the README.md.

If you are okay with my responses to your review comments, this PR is ready to merge.

PS: after merging this PR, we should merge master to PRs that have not run CI checks yet so that these PRs can be properly linted.

yikeke · 2019-07-09T02:40:54Z

@yikeke I've fixed the markdownlint errors introduced by the merge along with the errors in the README.md.

If you are okay with my responses to your review comments, this PR is ready to merge.

PS: after merging this PR, we should merge master to PRs that have not run CI checks yet so that these PRs can be properly linted.

Please take a final look at this PR. If it looks good to you, I'll notify all relevant members about this markdown lint check via email and then merge this PR. @lilin90

Please take a technical review at this. Thanks. @xuechunL @YiniXu9506

YiniXu9506 · 2019-07-09T03:43:30Z

LGTM

Signed-off-by: Aylei <rayingecho@gmail.com>

aylei · 2019-07-09T05:43:45Z

I've added the rule MD041, PTAL @yikeke

yikeke

LGTM. PTAL again. @lilin90

lilin90 · 2019-07-09T07:03:10Z

.markdownlint.yaml

+  style: atx
+no-trailing-spaces: true
+no-hard-tabs:
+  code_blocks: false


We also need this check in code blocks.

We need to make sure that people use spaces instead of tabs in code blocks too. Please change this setting, thanks! @aylei

lilin90 · 2019-07-09T07:18:14Z

.markdownlint.yaml

+no-space-in-links: true
+no-empty-links: true
+proper-names:
+  name: ['TiDB', 'TiKV', 'PingCAP']


We also have some lower-case TiDB or TiKV in normal text, such as some components, charts, or parameters with the inline code format.

Signed-off-by: Aylei <rayingecho@gmail.com>

aylei · 2019-07-09T07:31:39Z

@lilin90 Thanks! I've addressed the comments and PTAL

lilin90

LGTM

CaitinChen · 2019-07-11T02:59:16Z

@aylei Great!!!

Add markdownlint for dev folder

0d57759

Signed-off-by: Aylei <rayingecho@gmail.com>

aylei requested review from lilin90, CaitinChen and yikeke June 23, 2019 13:04

aylei changed the title ~~Add markdown style check for dev folder~~ [DNM] Add markdown style check for dev folder Jun 23, 2019

aylei added 4 commits June 24, 2019 14:48

Update circle.yml

38d9b58

Rename circle.yml to .circleci/config.yml

e79108a

Update config.yml

9194f3f

Update config.yml

a8952c4

aylei changed the title ~~[DNM] Add markdown style check for dev folder~~ Add markdown style check for dev folder Jun 24, 2019

aylei requested a review from xuechunL June 24, 2019 07:18

Update config.yml

08d8e29

lilin90 added the DNM label Jun 25, 2019

lilin90 removed the DNM label Jul 2, 2019

yikeke added the DNM label Jul 7, 2019

yikeke reviewed Jul 7, 2019

View reviewed changes

yikeke changed the title ~~Add markdown style check for dev folder~~ dev, .circleci/config.yml, .markdownlint.yaml: Add markdown style check for dev folder Jul 7, 2019

yikeke added the dev label Jul 7, 2019

Merge branch 'master' of https://github.com/pingcap/docs-cn into pr/1494

2b4bf7d

Fix markdownlint issues after merging

2104543

Signed-off-by: Aylei <rayingecho@gmail.com>

Add lint rule MD041

292fa18

Signed-off-by: Aylei <rayingecho@gmail.com>

yikeke reviewed Jul 9, 2019

View reviewed changes

yikeke removed the DNM label Jul 9, 2019

lilin90 reviewed Jul 9, 2019

View reviewed changes

aylei added 2 commits July 9, 2019 15:24

Comment out the proper names rule

1279361

Signed-off-by: Aylei <rayingecho@gmail.com>

Check hard tabs in code blocks

6e5f702

Signed-off-by: Aylei <rayingecho@gmail.com>

lilin90 approved these changes Jul 9, 2019

View reviewed changes

aylei merged commit f6b02ac into pingcap:master Jul 9, 2019

lilin90 added the website label Jul 9, 2019

yikeke mentioned this pull request Jul 11, 2019

*: fix markdownlint issues in all docs #1606

Merged

aylei mentioned this pull request Jul 11, 2019

Ignore .github and comment out single trailing new line #1611

Merged

This was referenced Jul 11, 2019

v2.1, v3.0, dev: fix more lint issues #1614

Merged

v3.0, dev/how-to/maintain: fix wording in kubernetes doc #1607

Merged

aylei mentioned this pull request Aug 2, 2019

*: add marklint check for changed files in PR pingcap/docs#1406

Merged

5 tasks

yikeke mentioned this pull request Aug 9, 2019

add script for running markdownlint locally pingcap/docs#1425

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

dev, .circleci/config.yml, .markdownlint.yaml: Add markdown style check for dev folder #1494

dev, .circleci/config.yml, .markdownlint.yaml: Add markdown style check for dev folder #1494

aylei commented Jun 23, 2019 •

edited by TomShawn

Loading

aylei commented Jun 24, 2019

aylei commented Jun 24, 2019

yikeke Jul 7, 2019

aylei Jul 8, 2019 •

edited

Loading

aylei Jul 8, 2019

yikeke Jul 7, 2019

aylei Jul 8, 2019

yikeke Jul 9, 2019

lilin90 Jul 9, 2019

aylei Jul 9, 2019 •

edited

Loading

yikeke commented Jul 7, 2019 •

edited

Loading

aylei commented Jul 8, 2019

yikeke commented Jul 8, 2019

aylei commented Jul 8, 2019

yikeke commented Jul 9, 2019

YiniXu9506 commented Jul 9, 2019

aylei commented Jul 9, 2019

yikeke left a comment

lilin90 Jul 9, 2019

yikeke Jul 9, 2019

lilin90 Jul 9, 2019

aylei commented Jul 9, 2019

lilin90 left a comment

CaitinChen commented Jul 11, 2019

	\|pd1\|`http://host1:2379`\|`http://host1:2380`\|
	\|pd1\|http://host1:2379\|http://host1:2380\|

dev, .circleci/config.yml, .markdownlint.yaml: Add markdown style check for dev folder #1494

dev, .circleci/config.yml, .markdownlint.yaml: Add markdown style check for dev folder #1494

Conversation

aylei commented Jun 23, 2019 • edited by TomShawn Loading

What is changed, added or deleted?

What is the related PR or file link(s)?

Which version does your change affect?

aylei commented Jun 24, 2019

aylei commented Jun 24, 2019

Choose a reason for hiding this comment

aylei Jul 8, 2019 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

aylei Jul 9, 2019 • edited Loading

Choose a reason for hiding this comment

yikeke commented Jul 7, 2019 • edited Loading

aylei commented Jul 8, 2019

yikeke commented Jul 8, 2019

aylei commented Jul 8, 2019

yikeke commented Jul 9, 2019

YiniXu9506 commented Jul 9, 2019

aylei commented Jul 9, 2019

yikeke left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

aylei commented Jul 9, 2019

lilin90 left a comment

Choose a reason for hiding this comment

CaitinChen commented Jul 11, 2019

aylei commented Jun 23, 2019 •

edited by TomShawn

Loading

aylei Jul 8, 2019 •

edited

Loading

aylei Jul 9, 2019 •

edited

Loading

yikeke commented Jul 7, 2019 •

edited

Loading