-
Notifications
You must be signed in to change notification settings - Fork 201
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: Readme updates to align with the new Red Hat template #4024
Merged
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-4024
# Activate the virtual environment
source test-avd-pr-4024/bin/activate
# Install all requirements including PyAVD
pip install "pyavd[ansible] @ git+https://github.com/JulioPDX/ansible-avd.git@readme-updates#subdirectory=python-avd" --force
# Install Ansible collection
ansible-galaxy collection install git+https://github.com/JulioPDX/ansible-avd.git#/ansible_collections/arista/avd/,readme-updates --force
# Optional: Install AVD examples
cd test-avd-pr-4024
ansible-playbook arista.avd.install_examples |
github-actions
bot
added
the
type: documentation
Improvements or additions to documentation
label
May 21, 2024
ClausHolbechArista
requested changes
May 22, 2024
ClausHolbechArista
requested changes
May 24, 2024
Co-authored-by: Claus Holbech <holbech@arista.com>
Quality Gate passedIssues Measures |
ClausHolbechArista
approved these changes
May 24, 2024
carlbuchmann
approved these changes
May 24, 2024
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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
README at the root of the collection has been updated to conform with the new Red Hat collection template. Due to not being able to link to files outside of the Mkdocs
docs_dir
location, the old README at the root of the collection has been renamed toindex.md
. This is used as the homepage on the documentation site. The root README for the repository is only used for GitHub.Proposed changes
Please see the change summary
How to test
No updates to main site docs.
Checklist
User Checklist
Repository Checklist