search

onosproject / onos-docs

Consolidated documentation for the ONOS project.
https://docs.onosproject.org
4 stars 10 forks source link

enable markdown linter for onos-docs #66

Closed adibrastegarnia closed 4 years ago

adibrastegarnia commented 4 years ago

To address issue #65 . We should merge the PRs related to the markdown linter in other repos first. We enabled the following rules: 

rule "MD001" # header levels increment by 1
rule "MD003", :style => :atx # header style - atx
rule "MD004", :style => :consistent # unordered list style - consistent
rule "MD005" # don't allow inconsistent indentation for list items
rule "MD006" # start bullets at beginning of line
rule "MD011" # Reversed link syntax
rule "MD014" # Dollar signs used before commands without showing output
rule "MD018" # No space after hash on atx style header
rule "MD023" # Headers must start at the beginning of the line
rule "MD024" # no multiple headers with same content
rule "MD028" # no blank lines within blockquote
rule "MD034" # Bare URL used
rule "MD037" # Spaces inside emphasis markers
rule "MD038" # Spaces inside code span elements
rule "MD039" # Spaces inside link text
rule "MD040" # Fenced code blocks should have a language specified
rule "MD046" #  Code block style

For more information: https://github.com/markdownlint/markdownlint/blob/master/docs/RULES.md

adibrastegarnia commented 4 years ago

@SeanCondon I addressed your comments. For now, I provided a set of paths to markdown linter until I write a script that filters them properly. Before merge this, we need to merge PRs in onos-topo, onos-ztp, onos-test.