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: Added support for skip the TOC on fabric and device documentation #4796

Merged
merged 13 commits into from
Jan 13, 2025

Conversation

MaheshGSLAB
Copy link
Contributor

Change Summary

Added support for skip the TOC on fabric and device documentation.

Related Issue(s)

Fixes #2243

Component(s) name

arista.avd.<role-name>

Proposed changes

Added support for skip the TOC on fabric and device documentation

How to test

Run molecule

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)

@MaheshGSLAB MaheshGSLAB self-assigned this Dec 9, 2024
Copy link

github-actions bot commented Dec 9, 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-4796
# Activate the virtual environment
source test-avd-pr-4796/bin/activate
# Install all requirements including PyAVD
pip install "pyavd[ansible] @ git+https://github.com/MaheshGSLAB/ansible-avd.git@issue-2243#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/MaheshGSLAB/ansible-avd.git#/ansible_collections/arista/avd/,issue-2243 --force
# Optional: Install AVD examples
cd test-avd-pr-4796
ansible-playbook arista.avd.install_examples

@github-actions github-actions bot added role: eos_cli_config_gen issue related to eos_cli_config_gen role state: CI Updated CI scenario have been updated in the PR labels Dec 9, 2024
@MaheshGSLAB MaheshGSLAB marked this pull request as ready for review December 12, 2024 12:25
@MaheshGSLAB MaheshGSLAB requested review from a team as code owners December 12, 2024 12:25
@github-actions github-actions bot added the state: conflict PR with conflict label Dec 16, 2024
Copy link

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

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 Dec 17, 2024
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.

This is missing eos_designs. We can do a separate PR for that, but then it is important that we do not close the issue. (change fixes #... to fixes part of #...)

@MaheshGSLAB MaheshGSLAB marked this pull request as draft December 19, 2024 13:32
@github-actions github-actions bot added the role: eos_designs issue related to eos_designs role label Dec 19, 2024
@MaheshGSLAB MaheshGSLAB marked this pull request as ready for review December 20, 2024 06:41
@MaheshGSLAB MaheshGSLAB requested a review from a team December 31, 2024 05:53
Copy link
Contributor

@Shivani-gslab Shivani-gslab left a comment

Choose a reason for hiding this comment

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

LGTM

@gmuloc gmuloc merged commit eea4dd6 into aristanetworks:devel Jan 13, 2025
46 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
rn: Doc role: eos_cli_config_gen issue related to eos_cli_config_gen role role: eos_designs issue related to eos_designs role state: CI Updated CI scenario have been updated in the PR state: Documentation role Updated
Projects
None yet
Development

Successfully merging this pull request may close these issues.

allow to skip the TOC on fabric and device documentation
5 participants