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

Doc(eos_designs): Fix markdown errors, typos and update documentation #1402

Merged
merged 5 commits into from
Feb 4, 2022
Merged

Doc(eos_designs): Fix markdown errors, typos and update documentation #1402

merged 5 commits into from
Feb 4, 2022

Conversation

tgodaA
Copy link
Contributor

@tgodaA tgodaA commented Dec 14, 2021 •
edited
Loading

Change Summary

This PR focuses on improving eos_designs documentation and fixing most of the Markdown errors, typos in the AVD docs. Some tables in AVD docs were recreated in md format by replacing them with the old html format.

Updated first-project example with the latest knobs.

Related Issue(s)

Component(s) name

arista.avd.eos_designs

Proposed changes

Improve documentation

How to test

Not required

Checklist

User Checklist

  • N/A

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_designs issue related to eos_designs role state: Documentation role Updated type: documentation Improvements or additions to documentation labels Dec 14, 2021
@tgodaA tgodaA force-pushed the doc branch 2 times, most recently from 991178a to 54ecd0c Compare December 16, 2021 23:59
@tgodaA tgodaA requested a review from emilarista December 17, 2021 00:23
@tgodaA tgodaA added this to the v3.2.0 milestone Dec 17, 2021
emilarista
emilarista requested changes Dec 17, 2021
View reviewed changes
ansible_collections/arista/avd/docs/contribution/overview.md Outdated Show resolved Hide resolved
ansible_collections/arista/avd/docs/contribution/overview.md Outdated Show resolved Hide resolved
ansible_collections/arista/avd/docs/contribution/setup-environment.md Outdated Show resolved Hide resolved
ansible_collections/arista/avd/docs/contribution/setup-environment.md Outdated Show resolved Hide resolved
ansible_collections/arista/avd/docs/contribution/setup-environment.md Outdated Show resolved Hide resolved
ansible_collections/arista/avd/docs/how-to/first-project.md Outdated Show resolved Hide resolved
ansible_collections/arista/avd/docs/how-to/first-project.md Show resolved Hide resolved
ansible_collections/arista/avd/docs/how-to/tower-integration.md Outdated Show resolved Hide resolved
ansible_collections/arista/avd/docs/modules/configlet_build_config.rst.md Outdated Show resolved Hide resolved
ansible_collections/arista/avd/docs/modules/inventory_to_container.rst.md Outdated Show resolved Hide resolved
@tgodaA tgodaA requested a review from emilarista December 17, 2021 15:24
@carlbuchmann carlbuchmann removed this from the v3.2.0 milestone Dec 17, 2021
emilarista
emilarista previously approved these changes Dec 17, 2021
View reviewed changes
Copy link
Contributor

@emilarista emilarista left a comment

Choose a reason for hiding this comment

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

LGTM!

@tgodaA tgodaA added this to the v3.3.0 milestone Jan 26, 2022
ClausHolbechArista
ClausHolbechArista approved these changes Jan 27, 2022
View reviewed changes
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.

LGTM. Thank you for all these fixes.

@tgodaA tgodaA requested a review from xaviramon February 1, 2022 14:03
carlbuchmann
carlbuchmann approved these changes Feb 3, 2022
View reviewed changes
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!

@tgodaA tgodaA requested a review from a team as a code owner February 3, 2022 02:48
@ClausHolbechArista ClausHolbechArista merged commit 8fbb43f into aristanetworks:devel Feb 4, 2022
@tgodaA tgodaA deleted the doc branch February 8, 2022 02:14
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@carlbuchmann carlbuchmann carlbuchmann approved these changes

@titom73 titom73 Awaiting requested review from titom73

@onurgashi onurgashi Awaiting requested review from onurgashi

@ankudinov ankudinov Awaiting requested review from ankudinov

@emilarista emilarista Awaiting requested review from emilarista

@xaviramon xaviramon Awaiting requested review from xaviramon

@ClausHolbechArista ClausHolbechArista Awaiting requested review from ClausHolbechArista

Assignees

@tgodaA tgodaA

Labels
role: eos_designs issue related to eos_designs role state: Documentation role Updated type: documentation Improvements or additions to documentation
Projects
None yet
Milestone
v3.3.0
Development

Successfully merging this pull request may close these issues.
5 participants
@tgodaA @xaviramon @carlbuchmann @ClausHolbechArista @emilarista