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: Fix mkdocs broken requirement links in roles #4039

Merged
merged 1 commit into from
May 24, 2024

Conversation

gmuloc
Copy link
Contributor

@gmuloc gmuloc commented May 24, 2024

Change Summary

We broke some links, this unbroke the links

Component(s) name

documentation

Proposed changes

  • fix the links
  • turns mkdocs warnings into errors to prevent this to ever happening agin

How to test

doc builds without warning, anyway now warnings are errors so this is better!\

Checklist

User Checklist

  • click the links and marvel

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)

@gmuloc gmuloc requested review from a team as code owners May 24, 2024 15:38
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-4039
# Activate the virtual environment
source test-avd-pr-4039/bin/activate
# Install all requirements including PyAVD
pip install "pyavd[ansible] @ git+https://github.com/gmuloc/avd.git@fix-mkdocs#subdirectory=python-avd" --force
# Install Ansible collection
ansible-galaxy collection install git+https://github.com/gmuloc/avd.git#/ansible_collections/arista/avd/,fix-mkdocs --force
# Optional: Install AVD examples
cd test-avd-pr-4039
ansible-playbook arista.avd.install_examples

@gmuloc gmuloc changed the title Doc: Fix mkdocs broken warning links Doc: Fix mkdocs broken requirement links in roles May 24, 2024
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.0% Duplication on New Code

See analysis details on SonarCloud

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 75877fd into aristanetworks:devel May 24, 2024
44 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants