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): How-to guide and porting guide updates for description templates #4558

Merged

Conversation

carlbuchmann
Copy link
Member

@carlbuchmann carlbuchmann commented Oct 7, 2024

Change Summary

Documentation updates for description templates:

  • new how-to guide
  • 5.x porting guide

Related Issue(s)

Fixes #2321

Component(s) name

arista.avd.eos_designs

Copy link

github-actions bot commented Oct 7, 2024

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-4558
# Activate the virtual environment
source test-avd-pr-4558/bin/activate
# Install all requirements including PyAVD
pip install "pyavd[ansible] @ git+https://github.com/carlbuchmann/avd.git@descriptions-format-how-to#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/carlbuchmann/avd.git#/ansible_collections/arista/avd/,descriptions-format-how-to --force
# Optional: Install AVD examples
cd test-avd-pr-4558
ansible-playbook arista.avd.install_examples

@github-actions github-actions bot added the type: documentation Improvements or additions to documentation label Oct 7, 2024
@carlbuchmann carlbuchmann added this to the v5.0.0 milestone Oct 7, 2024
@carlbuchmann carlbuchmann marked this pull request as ready for review October 10, 2024 20:42
@carlbuchmann carlbuchmann requested review from a team as code owners October 10, 2024 20:42
@carlbuchmann carlbuchmann requested a review from JulioPDX October 10, 2024 20:43
Copy link
Contributor

@JulioPDX JulioPDX left a comment

Choose a reason for hiding this comment

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

Added minor edits, LGTM

Copy link

@carlbuchmann carlbuchmann merged commit bf35305 into aristanetworks:devel Oct 11, 2024
40 checks passed
nathanmusser pushed a commit to nathanmusser/avd that referenced this pull request Oct 16, 2024
…ion templates (aristanetworks#4558)

Co-authored-by: JulioPDX <juliop503@gmail.com>
Co-authored-by: Claus Holbech <holbech@arista.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
rn: Doc(eos_designs) 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.

Improve description format and options
4 participants