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.

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

Feat(eos_cli_config_gen): Improve generated documentation #3377

Merged
merged 5 commits into from
Dec 5, 2023
Merged

Feat(eos_cli_config_gen): Improve generated documentation #3377

merged 5 commits into from
Dec 5, 2023
+1,709 −1,777

Conversation

carlbuchmann
Copy link
Member

@carlbuchmann carlbuchmann commented Nov 24, 2023 •
edited
Loading

Change Summary

Fix various markdown lint issues in eos_cli_config_gen documentation.

Related Issue(s)

Fixes #3375

Component(s) name

arista.avd.eos_cli_config_gen

Proposed changes

  • Enforce markdown lint on all molecule-generated artifacts
  • Fix molecule documentation
  • Fix various eos_cli_config_gen documentation templates:
    • fix defined logic
    • improve headings
    • remove emphasis
    • remove extra whitespace
    • remove else logic to print when no configuration present i.e.

How to test

run pre-commit run markdownlint --all

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)

@github-actions github-actions bot added role: eos_cli_config_gen issue related to eos_cli_config_gen role state: CI Updated CI scenario have been updated in the PR labels Nov 24, 2023
@carlbuchmann carlbuchmann changed the title Fix(eos_cli_config_gen): Make markdown docs pass linting rules Fix(eos_cli_config_gen): Make generated documentation pass markdown linting rules Nov 24, 2023
@carlbuchmann carlbuchmann added type: code quality CI and development toolset type: bug Something isn't working labels Nov 24, 2023
@carlbuchmann carlbuchmann mentioned this pull request Nov 24, 2023
Closed
1 task
@carlbuchmann carlbuchmann marked this pull request as ready for review November 24, 2023 15:39
@carlbuchmann carlbuchmann requested review from a team as code owners November 24, 2023 15:39
@github-actions github-actions bot removed the type: code quality CI and development toolset label Nov 24, 2023
@carlbuchmann carlbuchmann force-pushed the fix-markdown-docs-cli-gen branch from 194957a to f495ff2 Compare November 28, 2023 01:52
@ClausHolbechArista ClausHolbechArista marked this pull request as draft November 30, 2023 15:59
@carlbuchmann carlbuchmann force-pushed the fix-markdown-docs-cli-gen branch from 0e10562 to 65670c5 Compare December 1, 2023 13:20
@carlbuchmann carlbuchmann changed the title Fix(eos_cli_config_gen): Make generated documentation pass markdown linting rules Feat(eos_cli_config_gen): Improve generated documentation Dec 1, 2023
@ClausHolbechArista ClausHolbechArista removed the type: bug Something isn't working label Dec 1, 2023
@carlbuchmann carlbuchmann marked this pull request as ready for review December 1, 2023 14:15
@carlbuchmann carlbuchmann added this to the v4.5.0 milestone Dec 1, 2023
@carlbuchmann carlbuchmann merged commit 44b6242 into aristanetworks:devel Dec 5, 2023
39 of 40 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@ClausHolbechArista ClausHolbechArista ClausHolbechArista approved these changes

@gmuloc gmuloc gmuloc approved these changes

Assignees

@carlbuchmann carlbuchmann

Labels
rn: Feat(eos_cli_config_gen) role: eos_cli_config_gen issue related to eos_cli_config_gen role state: CI Updated CI scenario have been updated in the PR
Projects
None yet
Milestone
v4.5.0
Development

Successfully merging this pull request may close these issues.

[Feature] collection artifacts should pass default lint rules
3 participants
@carlbuchmann @gmuloc @ClausHolbechArista