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

Doc(eos_designs, eos_cli_config_gen): Various doc improvements #3001

Merged

Conversation

carlbuchmann
Copy link
Member

@carlbuchmann carlbuchmann commented Jun 21, 2023

Change Summary

  • Updates the landing page for GitHub and avd.arista.com
  • Put all examples in new section "Examples" as opposed to "Getting Started".
  • Augment details for custom templates with node type customization
  • Add information for default_node_types
  • Cut "Input Variables.md" from eos_cli_config_gen doc, no longer in use.
  • Fix TODOs in porting guide
  • Add tip to custom templates in eos_cli_config_gen
  • Fix mermaid diagram rendering
    • Had to cut custom name for the classes, as MKDOCs do not support it
    • Investigated alternate MKDOCs plugins to change version, but none were found.
  • Diagram for pyavd functions
  • Fixes Fix(eos_designs): Doc typo in input variables #3019

Component(s) name

arista.avd.eos_designs

How to test

N/A

@carlbuchmann carlbuchmann requested review from a team as code owners June 21, 2023 20:31
@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: Documentation role Updated labels Jun 21, 2023
@carlbuchmann carlbuchmann changed the title Doc(eos_designs): Add details for node type settings Doc(eos_designs): Various doc improvements Jun 22, 2023
@carlbuchmann carlbuchmann changed the title Doc(eos_designs): Various doc improvements Doc(eos_designs, eos_cli_config_gen): Various doc improvements Jun 22, 2023
@carlbuchmann carlbuchmann marked this pull request as draft June 22, 2023 12:34
@github-actions github-actions bot added the type: documentation Improvements or additions to documentation label Jun 22, 2023
@carlbuchmann carlbuchmann marked this pull request as ready for review June 27, 2023 15:35
@carlbuchmann
Copy link
Member Author

#3019 has been address with a2bbf1f

README.md Show resolved Hide resolved
@ClausHolbechArista ClausHolbechArista linked an issue Jul 6, 2023 that may be closed by this pull request
1 task
@carlbuchmann carlbuchmann merged commit 2d3a0e9 into aristanetworks:devel Jul 7, 2023
35 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
rn: Doc(eos_designs|eos_cli_config_gen) role: eos_cli_config_gen issue related to eos_cli_config_gen role role: eos_designs issue related to eos_designs role state: Documentation role Updated type: documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Fix(eos_designs): Doc typo in input variables
3 participants