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: Readme updates to align with the new Red Hat template #4024

Merged
merged 14 commits into from
May 24, 2024

Conversation

JulioPDX
Copy link
Contributor

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 to index.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

  • 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)

@JulioPDX JulioPDX requested review from a team as code owners May 21, 2024 18:33
@JulioPDX JulioPDX self-assigned this May 21, 2024
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-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 github-actions bot added the type: documentation Improvements or additions to documentation label May 21, 2024
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
ansible_collections/arista/avd/README.md Outdated Show resolved Hide resolved
ansible_collections/arista/avd/index.md Outdated Show resolved Hide resolved
ansible_collections/arista/avd/index.md Outdated Show resolved Hide resolved
ansible_collections/arista/avd/index.md Outdated Show resolved Hide resolved
ansible_collections/arista/avd/index.md Outdated Show resolved Hide resolved
ansible_collections/arista/avd/index.md Outdated Show resolved Hide resolved
@ClausHolbechArista ClausHolbechArista added this to the v4.8.0 milestone May 22, 2024
README.md Outdated Show resolved Hide resolved
LICENSE Outdated Show resolved Hide resolved
ansible_collections/arista/avd/LICENSE Outdated Show resolved Hide resolved
README.md Show resolved Hide resolved
ansible_collections/arista/avd/index.md Show resolved Hide resolved
ansible_collections/arista/avd/README.md Show resolved Hide resolved
Copy link

sonarcloud bot commented May 24, 2024

Quality Gate Passed Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
No data about Coverage
0.3% Duplication on New Code

See analysis details on SonarCloud

@carlbuchmann carlbuchmann self-requested a review May 24, 2024 14:14
Copy link
Member

@carlbuchmann carlbuchmann left a comment

Choose a reason for hiding this comment

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

LGTM

@carlbuchmann carlbuchmann merged commit 588b3bd into aristanetworks:devel May 24, 2024
38 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
rn: Doc type: documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants