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: Update single dc l3ls example #4829

Open
wants to merge 26 commits into
base: devel
Choose a base branch
from

Conversation

joelbreton2
Copy link
Contributor

Change Summary

Doc: Update single dc l3ls example

Related Issue(s)

aristanetworks/avd-internal#176

Copy link

Review docs on Read the Docs

To test this pull request:

# Create virtual environment for this testing below the current directory
python -m venv test-avd-pr-4829
# Activate the virtual environment
source test-avd-pr-4829/bin/activate
# Install all requirements including PyAVD
pip install "pyavd[ansible] @ git+https://github.com/joelbreton2/avd.git@update-single-DC-L3LS#subdirectory=python-avd" --force
# Point Ansible collections path to the Python virtual environment
export ANSIBLE_COLLECTIONS_PATH=$VIRTUAL_ENV/ansible_collections
# Install Ansible collection
ansible-galaxy collection install git+https://github.com/joelbreton2/avd.git#/ansible_collections/arista/avd/,update-single-DC-L3LS --force
# Optional: Install AVD examples
cd test-avd-pr-4829
ansible-playbook arista.avd.install_examples

Copy link

This pull request has conflicts, please resolve those before we can evaluate the pull request.

@github-actions github-actions bot added the state: conflict PR with conflict label Jan 24, 2025
Copy link

Conflicts have been resolved. A maintainer will review the pull request shortly.

@github-actions github-actions bot removed the state: conflict PR with conflict label Jan 29, 2025
@gmuloc gmuloc marked this pull request as ready for review February 21, 2025 14:30
@gmuloc gmuloc requested review from a team as code owners February 21, 2025 14:30
@JulioPDX JulioPDX force-pushed the update-single-DC-L3LS branch from 6997f7d to 5fac225 Compare February 26, 2025 19:44
Copy link
Contributor

@ankudinov ankudinov left a comment

Choose a reason for hiding this comment

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

LGTM, except minor comment above. Tested on Codespaces - works well.

---
<!--
~ Copyright (c) 2023-2025 Arista Networks, Inc.
~ Use of this source code is governed by the Apache License 2.0
~ that can be found in the LICENSE file.
-->

# AVD example for a single data center using L3LS
# Single Data Center - L3LS
Copy link
Contributor

Choose a reason for hiding this comment

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

Please add the link to AVD docs somewhere after this title and make it visible. The reason is that some users (like me) can unpack the example with cp -r /home/avd/.ansible/collections/ansible_collections/arista/avd/examples/single-dc-l3ls/* . and start checking readme in the root. The preview will not work correctly and the link pointing to the docs can save a lot of time. Long term we should be able to serve example docs locally as well.

@JulioPDX
Copy link
Contributor

@ankudinov Were going to edit the codeblocks and comments just a bit more for annotations then we will be ready for a final review. Thank you for taking a look!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants