Add Markdown linting

Change-Id: I6232763c39c2369e5352033ffbffc831aa5e148e
Signed-off-by: Thanh Ha <thanh.ha@linuxfoundation.org>

diff --git a/.coafile b/.coafile
index df817fc..26ef6c1 100644 (file)
--- a/.coafile
+++ b/.coafile
@@ -14,6 +14,13 @@ ignore = .git/**,
 indent_size = 4
 use_spaces = true
 
+[MarkDown]
+bears = MarkdownBear,SpaceConsistencyBear
+files = **/*.md, **/*.markdown
+ignore = .git/**,
+    .tox/**
+use_spaces = true
+
 [ShellCheck]
 bears = ShellCheckBear,SpaceConsistencyBear
 files = **/*.sh

diff --git a/README.md b/README.md
index 63cdff3..c12f321 100644 (file)
--- a/README.md
+++ b/README.md
@@ -17,6 +17,7 @@ LOGS_SERVER=https://logs.opendaylight.org
 NEXUS_URL=https://nexus.opendaylight.org
 SILO=releng
 ```
+
 Note: **GIT_CLONE_URL** is only used by Github projects as this
 will be different from the URL used the poperties
 configuration.
@@ -82,7 +83,7 @@ If you are using GitHub then there are two more parameters which
 will need to be placed in the defaults.yaml
 
 **git-url**: This should be set to the base URL of your GitHub. In
-general this should be https://github.com. If you are using GitHub
+general this should be <https://github.com>. If you are using GitHub
 Enterprise, or some other GitHub-style system, then it should be
 whatever your installation base URL is.
 
@@ -193,7 +194,7 @@ in the same structure as configured in the archives directory.
 
 2) Via job variable ARCHIVE_ARTIFACTS using globstar patterns.
 
-In this method a job can define a globstar for example ``**/*.log`` which then
+In this method a job can define a globstar for example `**/*.log` which then
 causes the archive script to do a globstar search for that pattern and archives
 any files it finds matching.
 
@@ -205,4 +206,3 @@ If ShellCheck is being used to lint global-jjb or any projects that include
 global-jjb as part of their project (common with ci-management repos) then
 a minimum version of ShellCheck 0.4.x is required as the shell scripts in
 this repo uses annotations that were introduced in 0.4..
-

diff --git a/tox.ini b/tox.ini
index 0f41803..c4fc24c 100644 (file)
--- a/tox.ini
+++ b/tox.ini
@@ -8,7 +8,11 @@ basepython = python3
 deps =
     coala
     coala-bears
+    # Markdown lint requires nodejs
+    nodeenv
 commands =
+    nodeenv -p
+    npm install --global remark-cli remark-lint
     python3 -m nltk.downloader punkt maxent_treebank_pos_tagger averaged_perceptron_tagger
     coala --non-interactive