Add markdownlint to Circle CI config (#268)

* Add markdownlint to Circle CI config

* Use markdownlint instead of markdownlint-cli

* Disable line length check (MD013)

* Add .mdlrc, .mdlstyle.rb

* Disable ordered list item (MD029)

* Use .mdlrc in circle ci scripts

* Fix errors and update exclusion rules

.circleci/config.yml

@@ -2,11 +2,29 @@
 version: 2
 
 jobs:
-  build:
+  misspell:
     docker:
       - image: circleci/golang:1.12
     steps:
       - checkout
       - run:
-          name: Verify
+          name: Misspell check
           command: make precommit
+  markdownlint:
+    docker:
+      - image: circleci/ruby:latest
+    steps:
+      - checkout
+      - run:
+          name: Install markdownlint
+          command: gem install mdl
+      - run:
+          name: Check markdownlint
+          command: mdl -c .mdlrc .
+
+workflows:
+  version: 2
+  build:
+    jobs:
+      - misspell
+      - markdownlint

.mdlrc

@@ -0,0 +1 @@
+style ".mdlstyle.rb"

.mdlstyle.rb

@@ -0,0 +1,19 @@
+all
+
+# Multiple headings with the same content allowed for sibling headings
+rule 'MD024', :allow_different_nesting => true
+
+# Ordered lists should have increasing prefixes
+rule 'MD029', :style => :ordered
+
+# Ignore unordered list style
+exclude_rule 'MD004'
+
+# Ignore line length
+exclude_rule 'MD013'
+
+# Inline HTML
+exclude_rule 'MD033'
+
+# Fenced code blocks should have a language specified
+exclude_rule 'MD040'

.vscode/settings.json

@@ -2,6 +2,11 @@
     "rewrap.wrappingColumn": 80,
     "editor.rulers": [80],
     "markdownlint.config": {
-        "MD013": true
+        "MD004": false,
+        "MD013": false,
+        "MD024": {"allow_different_nesting": true},
+        "MD029": {"style": "ordered"},
+        "MD033": false,
+        "MD040": false,
     },
-}
+}

milestones.md

@@ -84,14 +84,14 @@ In scope of SDK Alpha release are:
   - Jaeger and/or Zipkin exporter
 - Context Propagation
   - In-process propagation
-  - Inject and Extract 
+  - Inject and Extract
   - DistributedContext
 - Metrics
   - MetricsProcessor interface
   - Aggregation MetricsProcessor
   - Exporter interface
   - Prometheus Exporter
-  
+
 Also in scope:
 
 - Jaeger and/or Zipkin exporter