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: Move docs folder to root of repo #4923

Merged
merged 21 commits into from
Jan 24, 2025

Conversation

carlbuchmann
Copy link
Member

@carlbuchmann carlbuchmann commented Jan 23, 2025

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

  • Moved ./ansible_collections/arista/avd/docs to ./docs
  • Moved ./ansible_collections/arista/avd/media/* to ./docs/_media/*
  • Updated all relative path links
  • updated mkdocs configuration
    • added same-dir plugin requirement
    • excluded folders:
      - development/*
      - galaxy-importer/*
      - python-avd/*
  • updated old avd.sh links to avd.arista.com
  • Updated pre-commit hooks for ansible plugins documentation

Todo after we merge this PR

  • Update avd-docs and read the docs to point to new requirements file:
    • ./avd/docs/requirements.txt
  • Once confirmed we will submit a PR to delete:
    • /avd/ansible_collections/arista/avd/docs/requirements.txt

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)

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-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 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 github-actions bot added the type: dependencies Pull requests that update a dependency file label Jan 23, 2025
@github-actions github-actions bot added the type: code quality CI and development toolset label Jan 24, 2025
@github-actions github-actions bot added the role: build_output_folders issue related to build_output_folders role label Jan 24, 2025
@carlbuchmann carlbuchmann marked this pull request as ready for review January 24, 2025 14:36
@carlbuchmann carlbuchmann requested review from a team as code owners January 24, 2025 14:36
mkdocs.yml Outdated Show resolved Hide resolved
index.md Outdated Show resolved Hide resolved
index.md Outdated Show resolved Hide resolved
Co-authored-by: Guillaume Mulocher <[email protected]>
Copy link
Contributor

@joelbreton2 joelbreton2 left a comment

Choose a reason for hiding this comment

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

LGTM

Copy link
Contributor

@gmuloc gmuloc left a 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 :)

@carlbuchmann carlbuchmann merged commit 11b7a06 into aristanetworks:devel Jan 24, 2025
58 checks passed
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
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants