feature: add circleci to pouch to validate markdown files

[allencloud]

Signed-off-by: Allen Sun [email protected]

Ⅰ. Describe what this PR did

We need a standard to validate all MarkDown files in Pouch project. After finding all related tools, I decided to try markdownlint (https://github.com/markdownlint/markdownlint).

We have already use travisCI to finish unit test and integration test, this time I try to take advantages of circleCI to finish this part.

In the future, I will support webhook of circleCI in @pouchrobot to make it info pull request circleCI error when it fails.

Ⅱ. Does this pull request fix one issue?

none

Ⅲ. Describe how you did it

None

Ⅳ. Describe how to verify it

None

Ⅴ. Special notes for reviews

Currently I think the circleCI will fail with no doubt, since no one write markdown files according to markdownlint.

cc @HusterWan @Letty5411

[allencloud]

The error message will be like the following and to understand MD003 Header style, we need to refer to https://github.com/markdownlint/markdownlint/blob/master/docs/RULES.md:

find  ./ -name  "*.md" | grep -v vendor | grep -v extra | grep -v commandline | grep -v .github | grep -v swagger | grep -v api | xargs mdl
./README.md:13: MD003 Header style
./README.md:24: MD003 Header style
./README.md:32: MD003 Header style
./README.md:42: MD003 Header style
./README.md:46: MD003 Header style
./README.md:50: MD003 Header style
./README.md:58: MD003 Header style
./README.md:66: MD003 Header style
./README.md:70: MD003 Header style
./README.md:74: MD003 Header style
./README.md:78: MD003 Header style
./README.md:82: MD003 Header style
.......
./README.md:30: MD013 Line length
./README.md:36: MD013 Line length
./README.md:37: MD013 Line length
./README.md:38: MD013 Line length
./README.md:39: MD013 Line length
./README.md:40: MD013 Line length
......
./FAQ.md:35: MD013 Line length
./FAQ.md:39: MD013 Line length
./FAQ.md:40: MD013 Line length
./FAQ.md:41: MD013 Line length
./FAQ.md:42: MD013 Line length
./FAQ.md:46: MD013 Line length
./FAQ.md:48: MD013 Line length
./FAQ.md:50: MD013 Line length
./FAQ.md:54: MD013 Line length
./FAQ.md:56: MD013 Line length
./FAQ.md:60: MD013 Line length
./FAQ.md:3: MD026 Trailing punctuation in header
./FAQ.md:13: MD026 Trailing punctuation in header
./FAQ.md:17: MD026 Trailing punctuation in header
./FAQ.md:25: MD026 Trailing punctuation in header
./FAQ.md:33: MD026 Trailing punctuation in header
./FAQ.md:44: MD026 Trailing punctuation in header
./FAQ.md:52: MD026 Trailing punctuation in header
./FAQ.md:58: MD026 Trailing punctuation in header
./FAQ.md:62: MD026 Trailing punctuation in header
./FAQ.md:66: MD026 Trailing punctuation in header
./docs/README.md:11: MD007 Unordered list indentation
./docs/README.md:23: MD009 Trailing spaces
./docs/README.md:35: MD009 Trailing spaces
./docs/README.md:3: MD013 Line length
./docs/README.md:23: MD013 Line length
./docs/README.md:27: MD013 Line length
./docs/README.md:31: MD013 Line length
./docs/README.md:35: MD013 Line length
./docs/README.md:39: MD013 Line length
./docs/README.md:43: MD013 Line length
./docs/README.md:47: MD013 Line length
./docs/README.md:51: MD013 Line length
./docs/README.md:55: MD013 Line length
./docs/README.md:59: MD013 Line length
./docs/README.md:63: MD013 Line length
./docs/README.md:67: MD013 Line length
./docs/README.md:71: MD013 Line length
./docs/kubernetes/pouch_with_cri_introduction.md:5: MD009 Trailing spaces
./docs/kubernetes/pouch_with_cri_introduction.md:5: MD013 Line length
./docs/kubernetes/pouch_with_cri_introduction.md:6: MD013 Line length
./docs/kubernetes/pouch_with_cri_introduction.md:14: MD013 Line length
./docs/kubernetes/pouch_with_cri_introduction.md:22: MD013 Line length
./docs/kubernetes/pouch_with_cri_introduction.md:25: MD013 Line length
./docs/kubernetes/pouch_with_cri_introduction.md:27: MD013 Line length
./docs/kubernetes/pouch_with_cri_introduction.md:28: MD013 Line length
./docs/kubernetes/pouch_with_cri_introduction.md:29: MD013 Line length
./docs/kubernetes/pouch_with_cri_introduction.md:31: MD013 Line length
./docs/kubernetes/pouch_with_kubernetes_deploying.md:4: MD007 Unordered list indentation
./docs/kubernetes/pouch_with_kubernetes_deploying.md:7: MD007 Unordered list indentation
./docs/kubernetes/pouch_with_kubernetes_deploying.md:20: MD009 Trailing spaces
./docs/kubernetes/pouch_with_kubernetes_deploying.md:34: MD012 Multiple consecutive blank lines
./docs/kubernetes/pouch_with_kubernetes_deploying.md:52: MD013 Line length
./docs/kubernetes/pouch_with_kubernetes_deploying.md:61: MD013 Line length
./docs/kubernetes/pouch_with_kubernetes_deploying.md:122: MD013 Line length
./docs/kubernetes/pouch_with_kubernetes_deploying.md:123: MD013 Line length
./docs/kubernetes/pouch_with_kubernetes_deploying.md:124: MD013 Line length
./docs/kubernetes/pouch_with_kubernetes_deploying.md:125: MD013 Line length
./docs/kubernetes/pouch_with_kubernetes_deploying.md:129: MD013 Line length
./docs/kubernetes/pouch_with_kubernetes_deploying.md:128: MD022 Headers should be surrounded by blank lines
./docs/kubernetes/pouch_with_kubernetes_deploying.md:78: MD031 Fenced code blocks should be surrounded by blank lines
./docs/kubernetes/pouch_with_kubernetes_deploying.md:80: MD031 Fenced code blocks should be surrounded by blank lines
./docs/kubernetes/pouch_with_kubernetes_deploying.md:82: MD031 Fenced code blocks should be surrounded by blank lines
./docs/kubernetes/pouch_with_cri_verification.md:3: MD013 Line length
./docs/kubernetes/pouch_with_cri_verification.md:50: MD013 Line length
./docs/kubernetes/pouch_with_cri_verification.md:86: MD013 Line length
./docs/kubernetes/pouch_with_cri_verification.md:87: MD013 Line length
./docs/kubernetes/pouch_with_cri_verification.md:102: MD013 Line length
./docs/kubernetes/pouch_with_cri_verification.md:105: MD013 Line length
./docs/kubernetes/pouch_with_cri_verification.md:62: MD031 Fenced code blocks should be surrounded by blank lines
./docs/kubernetes/pouch_with_cri_verification.md:99: MD031 Fenced code blocks should be surrounded by blank lines
./docs/kubernetes/pouch_with_cri_verification.md:103: MD031 Fenced code blocks should be surrounded by blank lines
./docs/kubernetes/pouch_with_cri_verification.md:15: MD036 Emphasis used instead of a header
./docs/contributions/code_styles.md:21: MD009 Trailing spaces
./docs/contributions/code_styles.md:3: MD013 Line length
./docs/contributions/code_styles.md:7: MD013 Line length
./docs/contributions/code_styles.md:17: MD013 Line length
./docs/contributions/code_styles.md:21: MD013 Line length
./docs/contributions/code_styles.md:23: MD013 Line length
./docs/contributions/code_styles.md:24: MD013 Line length
./docs/contributions/code_styles.md:25: MD013 Line length
./docs/contributions/code_styles.md:26: MD013 Line length
./docs/contributions/code_styles.md:27: MD013 Line length
./docs/contributions/code_styles.md:28: MD013 Line length
./docs/contributions/code_styles.md:31: MD013 Line length
./docs/contributions/code_styles.md:31: MD038 Spaces inside code span elements
./docs/architecture.md:25: MD009 Trailing spaces
./docs/architecture.md:3: MD013 Line length
......

[allencloud]

LGTM, I am going to merge this first to check if this is correct in circleCI. Please feel free to ping me if anything unexpected happens.