Skip to content
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

Merged
merged 8 commits into from
Mar 17, 2023

Conversation

JulioPDX
Copy link
Contributor

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

  • Update Jinja templates to increase by 1
  • Corrected spacing between headings/TOC separation from main heading
  • Updated add_md_toc.py toc_levels to default of 3 (retains TOC view)

How to test

See updated artifacts

Checklist

Repository Checklist

  • My code has been rebased from devel before I start
  • I have read the CONTRIBUTING document.
  • My change requires a change to the documentation and documentation have been updated accordingly.
  • I have updated molecule CI testing accordingly. (check the box if not applicable)

@JulioPDX JulioPDX requested a review from a team as a code owner March 17, 2023 01:22
@github-actions github-actions bot added role: eos_cli_config_gen issue related to eos_cli_config_gen role role: eos_designs issue related to eos_designs role state: CI Updated CI scenario have been updated in the PR type: Python filters labels Mar 17, 2023
Copy link
Contributor

@ClausHolbechArista ClausHolbechArista left a 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

Copy link
Member

@carlbuchmann carlbuchmann left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@carlbuchmann carlbuchmann merged commit f51b65c into aristanetworks:devel Mar 17, 2023
@carlbuchmann carlbuchmann changed the title Refactor(eos_cli_config_gen, eos_designs): Remove multiple H1 headings Refactor(eos_cli_config_gen,eos_designs): Remove multiple H1 headings Mar 17, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
role: eos_cli_config_gen issue related to eos_cli_config_gen role role: eos_designs issue related to eos_designs role state: CI Updated CI scenario have been updated in the PR type: Python filters
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Remove multiple L1 markdown headers in the eos_cli_config_gen device documentation templates
3 participants