search

istio / istio.io

Source for the istio.io site
https://istio.io/
Apache License 2.0
761 stars 1.54k forks source link

Istio pages don't abide by the requirements of our linter #7906

Open brian-avery opened 4 years ago

brian-avery commented 4 years ago

We use markdown linter at different levels in tools and istio.io. The same docs break in tools that would normally pass istio.io. For example, the release notes break because there's no level 1 headers in the istio docs.

ericvn commented 4 years ago

specifically, there is a mdl.rb in the istio.io root directory which is different than the mdl.rb in common:

find . -name mdl.rb
./mdl.rb
./common/config/mdl.rb

The diff is level 1 headers:

diff mdl.rb common/config/mdl.rb
2c2
< rule 'MD002', :level => 2
---
> rule 'MD002', :level => 1