-
Notifications
You must be signed in to change notification settings - Fork 233
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: Move docs folder to root of repo #4923
Merged
carlbuchmann
merged 21 commits into
aristanetworks:devel
from
carlbuchmann:relocate-docs
Jan 24, 2025
Merged
Doc: Move docs folder to root of repo #4923
carlbuchmann
merged 21 commits into
aristanetworks:devel
from
carlbuchmann:relocate-docs
Jan 24, 2025
+580
−542
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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-4923
# Activate the virtual environment
source test-avd-pr-4923/bin/activate
# Install all requirements including PyAVD
pip install "pyavd[ansible] @ git+https://github.com/carlbuchmann/avd.git@relocate-docs#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/,relocate-docs --force
# Optional: Install AVD examples
cd test-avd-pr-4923
ansible-playbook arista.avd.install_examples |
github-actions
bot
added
type: documentation
Improvements or additions to documentation
role: cvp_configlet_upload
issue related to cvp_configlet_upload role
role: eos_cli_config_gen
issue related to eos_cli_config_gen role
role: eos_config_deploy_cvp
issue related to eos_config_deploy_cvp role
role: eos_config_deploy_eapi
issue related to eos_config_deploy_eapi role
role: eos_validate_state
role: dhcp_provisioner
state: Documentation role Updated
role: eos_snapshot
role: eos_designs
issue related to eos_designs role
labels
Jan 23, 2025
github-actions
bot
added
the
type: dependencies
Pull requests that update a dependency file
label
Jan 23, 2025
github-actions
bot
added
the
role: build_output_folders
issue related to build_output_folders role
label
Jan 24, 2025
gmuloc
reviewed
Jan 24, 2025
carlbuchmann
commented
Jan 24, 2025
gmuloc
reviewed
Jan 24, 2025
Co-authored-by: Guillaume Mulocher <[email protected]>
2 tasks
joelbreton2
approved these changes
Jan 24, 2025
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM
gmuloc
approved these changes
Jan 24, 2025
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
inspection of the changes look good to me
we will make this better down the line :)
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Labels
rn: Doc
role: build_output_folders
issue related to build_output_folders role
role: cvp_configlet_upload
issue related to cvp_configlet_upload role
role: dhcp_provisioner
role: eos_cli_config_gen
issue related to eos_cli_config_gen role
role: eos_config_deploy_cvp
issue related to eos_config_deploy_cvp role
role: eos_config_deploy_eapi
issue related to eos_config_deploy_eapi role
role: eos_designs
issue related to eos_designs role
role: eos_snapshot
role: eos_validate_state
state: Documentation role Updated
type: code quality
CI and development toolset
type: dependencies
Pull requests that update a dependency file
type: documentation
Improvements or additions to documentation
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Change Summary
Move docs folder to root of repo and update relative path links to included content
Component(s) name
AVD documentation website
Proposed changes
How to test
./ansible_collections/arista/avd/docs
to./docs
./ansible_collections/arista/avd/media/*
to./docs/_media/*
- development/*
- galaxy-importer/*
- python-avd/*
Todo after we merge this PR
./avd/docs/requirements.txt
/avd/ansible_collections/arista/avd/docs/requirements.txt
Repository Checklist