Skip to content

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

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Open
brian-avery opened this issue Aug 10, 2020 · 1 comment · May be fixed by #16316
Open

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

brian-avery opened this issue Aug 10, 2020 · 1 comment · May be fixed by #16316

Comments

@brian-avery
Copy link
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.
@ericvn
Copy link
Contributor

ericvn commented Aug 11, 2020 •
edited
Loading

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

@craigbox craigbox mentioned this issue May 20, 2024
Open
This was referenced Mar 6, 2025
Closed
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
2 participants
@brian-avery @ericvn