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: avd to cvaas #3089

Merged
merged 24 commits into from
Aug 21, 2023
Merged

Doc: avd to cvaas #3089

merged 24 commits into from
Aug 21, 2023

Conversation

kgiusti4130
Copy link
Contributor

@kgiusti4130 kgiusti4130 commented Aug 14, 2023 •
edited

Change Summary

Document the process of connecting AVD to CVaaS

Component(s) name

arista.avd.eos_designs

Proposed changes

Add AVD to CVaaS example to mkdocs

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)

@kgiusti4130 kgiusti4130 changed the title Document avd to cvaas Doc: avd to cvaas Aug 14, 2023
@kgiusti4130 kgiusti4130 marked this pull request as ready for review August 14, 2023 15:59
@kgiusti4130 kgiusti4130 requested review from a team as code owners August 14, 2023 15:59
noredistribution
noredistribution requested changes Aug 14, 2023
View reviewed changes
Copy link
Contributor

@noredistribution noredistribution left a comment

Choose a reason for hiding this comment

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

thanks for doing this, left a few suggestions!

ansible_collections/arista/avd/roles/eos_designs/docs/how-to/avd-to-cvaas.md Outdated Show resolved Hide resolved
ansible_collections/arista/avd/roles/eos_designs/docs/how-to/avd-to-cvaas.md Outdated Show resolved Hide resolved
ansible_collections/arista/avd/roles/eos_designs/docs/how-to/avd-to-cvaas.md Outdated Show resolved Hide resolved
ansible_collections/arista/avd/roles/eos_designs/docs/how-to/avd-to-cvaas.md Outdated Show resolved Hide resolved
ansible_collections/arista/avd/roles/eos_designs/docs/how-to/avd-to-cvaas.md Outdated Show resolved Hide resolved
noredistribution
noredistribution requested changes Aug 14, 2023
View reviewed changes
Copy link
Contributor

@noredistribution noredistribution left a comment

Choose a reason for hiding this comment

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

thanks for the updates, left few more comments

ansible_collections/arista/avd/roles/eos_designs/docs/how-to/avd-to-cvaas.md Outdated Show resolved Hide resolved
ansible_collections/arista/avd/roles/eos_designs/docs/how-to/avd-to-cvaas.md Outdated Show resolved Hide resolved
ansible_collections/arista/avd/roles/eos_designs/docs/how-to/avd-to-cvaas.md Outdated Show resolved Hide resolved
ansible_collections/arista/avd/roles/eos_designs/docs/how-to/avd-to-cvaas.md Outdated Show resolved Hide resolved
ansible_collections/arista/avd/roles/eos_designs/docs/how-to/avd-to-cvaas.md Outdated Show resolved Hide resolved
philippebureau
philippebureau approved these changes Aug 15, 2023
View reviewed changes
Copy link
Contributor

@philippebureau philippebureau left a comment

Choose a reason for hiding this comment

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

LGTM

noredistribution
noredistribution approved these changes Aug 15, 2023
View reviewed changes
Copy link
Contributor

@noredistribution noredistribution left a comment

Choose a reason for hiding this comment

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

LGTM!

ClausHolbechArista
ClausHolbechArista requested changes Aug 16, 2023
View reviewed changes
ansible_collections/arista/avd/roles/eos_designs/docs/how-to/avd-to-cvaas.md Outdated Show resolved Hide resolved
ansible_collections/arista/avd/roles/eos_designs/docs/how-to/avd-to-cvaas.md Outdated Show resolved Hide resolved
ansible_collections/arista/avd/roles/eos_designs/docs/how-to/avd-to-cvaas.md Outdated Show resolved Hide resolved
ansible_collections/arista/avd/roles/eos_designs/docs/how-to/avd-to-cvaas.md Outdated Show resolved Hide resolved
ansible_collections/arista/avd/roles/eos_designs/docs/how-to/avd-to-cvaas.md Outdated Show resolved Hide resolved
ansible_collections/arista/avd/roles/eos_designs/docs/how-to/avd-to-cvaas.md Outdated Show resolved Hide resolved
ansible_collections/arista/avd/roles/eos_designs/docs/how-to/avd-to-cvaas.md Outdated Show resolved Hide resolved
ansible_collections/arista/avd/roles/eos_designs/docs/how-to/avd-to-cvaas.md Outdated Show resolved Hide resolved
ansible_collections/arista/avd/roles/eos_designs/docs/how-to/avd-to-cvaas.md Outdated Show resolved Hide resolved
mkdocs.yml Outdated Show resolved Hide resolved
@ClausHolbechArista
Copy link
Contributor

Thank you for your hard work on this. Beware of the github gui hiding some comments:
image

@github-actions github-actions bot added role: eos_config_deploy_cvp issue related to eos_config_deploy_cvp role and removed role: eos_designs issue related to eos_designs role labels Aug 16, 2023
ClausHolbechArista
ClausHolbechArista requested changes Aug 17, 2023
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.

Thank you very much for this contribution. It will be very useful for most users of AVD.

I have submitted a few comments on minor formatting details.

ansible_collections/arista/avd/roles/eos_config_deploy_cvp/docs/avd-to-cvaas.md Outdated Show resolved Hide resolved
ansible_collections/arista/avd/roles/eos_config_deploy_cvp/docs/avd-to-cvaas.md Outdated Show resolved Hide resolved
ansible_collections/arista/avd/roles/eos_config_deploy_cvp/docs/avd-to-cvaas.md Outdated Show resolved Hide resolved
ansible_collections/arista/avd/roles/eos_config_deploy_cvp/docs/avd-to-cvaas.md Outdated Show resolved Hide resolved
ansible_collections/arista/avd/roles/eos_config_deploy_cvp/docs/avd-to-cvaas.md Outdated Show resolved Hide resolved
ansible_collections/arista/avd/roles/eos_config_deploy_cvp/docs/avd-to-cvaas.md Outdated Show resolved Hide resolved
ansible_collections/arista/avd/roles/eos_config_deploy_cvp/docs/avd-to-cvaas.md Outdated Show resolved Hide resolved
ansible_collections/arista/avd/roles/eos_config_deploy_cvp/docs/avd-to-cvaas.md Outdated Show resolved Hide resolved
ansible_collections/arista/avd/roles/eos_config_deploy_cvp/docs/avd-to-cvaas.md Outdated Show resolved Hide resolved
@ClausHolbechArista
Copy link
Contributor

@kgiusti4130 FYI you can see a preview of the generated page here: https://ansible-avd--3089.org.readthedocs.build/en/3089/roles/eos_config_deploy_cvp/docs/avd-to-cvaas.html

Any updates you submit will not take effect until we run the CI pipeline again. It would normally happen automatically, but since this is your first contribution, we need to approve it for every change.

@kgiusti4130
Copy link
Contributor Author

I believe I have now corrected all of the issues. When I committed my latest change I'm getting a pre-commit error regarding licensing on Markdown files. Can I please get some guidance on what I need to do in order to correct this?

error

@noredistribution
Copy link
Contributor

noredistribution commented Aug 18, 2023 •
edited

I believe I have now corrected all of the issues. When I committed my latest change I'm getting a pre-commit error regarding licensing on Markdown files. Can I please get some guidance on what I need to do in order to correct this?

error

can you rebase and then run pip3 install pre-commit --upgrade and pre-commit install-hooks and pre-commit run --all?

ClausHolbechArista
ClausHolbechArista approved these changes Aug 21, 2023
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.

Again thank you very much for this contribution.

@ClausHolbechArista ClausHolbechArista merged commit c29729b into aristanetworks:devel Aug 21, 2023
34 checks passed
@kgiusti4130
Copy link
Contributor Author

@ClausHolbechArista Happy to help, I appreciate all of your input and feedback in making this doc.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@philippebureau philippebureau philippebureau approved these changes

@noredistribution noredistribution noredistribution approved these changes

@ClausHolbechArista ClausHolbechArista ClausHolbechArista approved these changes

Assignees

@kgiusti4130 kgiusti4130

Labels
rn: Doc role: eos_config_deploy_cvp issue related to eos_config_deploy_cvp role state: Documentation role Updated
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
5 participants
@kgiusti4130 @ClausHolbechArista @noredistribution @philippebureau @KGiusti1