-
Notifications
You must be signed in to change notification settings - Fork 184
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.
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
Refactor(eos_cli_config_gen,eos_designs): Remove multiple H1 headings #2632
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This one was hard to review :)
I wanted to ensure that only headings changed and no TOCs changed - proving that you caught every single heading, since TOC would have caught it otherwise. So I had to get some help from egrep
:
holbech@holbech:~/ansible-avd/ansible_collections/arista/avd$ git diff devel | egrep '^[+-]' | egrep -v '^[+-]#' | egrep -v '^[+-]{3}' | egrep -v '^[+-]\ *$'
- ### SSH timeout and management
+ #### SSH timeout and management
- ### SSH timeout and management
+ #### SSH timeout and management
- ### SSH timeout and management
+ #### SSH timeout and management
- ### SSH timeout and management
+ #### SSH timeout and management
- ### SSH timeout and management
+ #### SSH timeout and management
- ### SSH timeout and management
+ #### SSH timeout and management
-def add_md_toc(md_input, skip_lines=0, toc_levels=2, toc_marker="<!-- toc -->"):
+def add_md_toc(md_input, skip_lines=0, toc_levels=3, toc_marker="<!-- toc -->"):
- How many levels of headings will be included in the TOC (Default:2)
- default: 2
+ How many levels of headings will be included in the TOC (Default:3)
+ default: 3
I have highlighted the space I think causes the heading for SSH timeout and management
to be indented.
Please also update the documentation for add_md_toc
in README.md
...le_collections/arista/avd/roles/eos_cli_config_gen/templates/documentation/management-ssh.j2
Outdated
Show resolved
Hide resolved
…tes/documentation/management-ssh.j2
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM
Change Summary
This PR removes the duplicate H1 headings in device and fabric documentation.
Related Issue(s)
Fixes #1748
Component(s) name
arista.avd.eos_cli_config_gen
arista.avd.eos_designs
Proposed changes
add_md_toc.py
toc_levels
to default of 3 (retains TOC view)How to test
See updated artifacts
Checklist
Repository Checklist