Skip to content

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

Open
@brian-avery

Description

@brian-avery
Member

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.

Activity

ericvn

ericvn commented on Aug 11, 2020

@ericvn
Contributor

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
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

      Participants

      @brian-avery@ericvn

      Issue actions

        Istio pages don't abide by the requirements of our linter · Issue #7906 · istio/istio.io