-
Notifications
You must be signed in to change notification settings - Fork 231
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: Adding contribution guide for eos_cli_config_gen #4730
Doc: Adding contribution guide for eos_cli_config_gen #4730
Conversation
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-4730
# Activate the virtual environment
source test-avd-pr-4730/bin/activate
# Install all requirements including PyAVD
pip install "pyavd[ansible] @ git+https://github.com/Shivani-gslab/avd.git@contribution_guide#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/Shivani-gslab/avd.git#/ansible_collections/arista/avd/,contribution_guide --force
# Optional: Install AVD examples
cd test-avd-pr-4730
ansible-playbook arista.avd.install_examples |
a8fd2f4
to
a43aa6d
Compare
ansible_collections/arista/avd/docs/contribution/authoring_eos_cli_config_gen.md
Outdated
Show resolved
Hide resolved
ansible_collections/arista/avd/docs/contribution/authoring_eos_cli_config_gen.md
Outdated
Show resolved
Hide resolved
ansible_collections/arista/avd/docs/contribution/authoring_eos_cli_config_gen.md
Outdated
Show resolved
Hide resolved
ansible_collections/arista/avd/docs/contribution/authoring_eos_cli_config_gen.md
Outdated
Show resolved
Hide resolved
ansible_collections/arista/avd/docs/contribution/authoring_eos_cli_config_gen.md
Outdated
Show resolved
Hide resolved
ansible_collections/arista/avd/docs/contribution/authoring_eos_cli_config_gen.md
Outdated
Show resolved
Hide resolved
ansible_collections/arista/avd/docs/contribution/authoring_eos_cli_config_gen.md
Outdated
Show resolved
Hide resolved
ansible_collections/arista/avd/docs/contribution/authoring_eos_cli_config_gen.md
Outdated
Show resolved
Hide resolved
ansible_collections/arista/avd/docs/contribution/authoring_eos_cli_config_gen.md
Outdated
Show resolved
Hide resolved
ansible_collections/arista/avd/docs/contribution/authoring_eos_cli_config_gen.md
Outdated
Show resolved
Hide resolved
48f50f1
to
49d0f13
Compare
ansible_collections/arista/avd/docs/contribution/authoring_eos_cli_config_gen.md
Show resolved
Hide resolved
ansible_collections/arista/avd/docs/contribution/authoring_eos_cli_config_gen.md
Outdated
Show resolved
Hide resolved
2ef2650
to
b89cdc0
Compare
Quality Gate passedIssues Measures |
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
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.
I would add some general notes in some places stating
- For PR writer to tag maintainers with questions even once they have pushed and to use draft PRs when things are not ready yet. (We can also discuss in the issue if requried)
- For PR reviewer - to tag maintainers when they have questions
I think you are missing to introduce the new md file in the TOC for mkdocs (you need tp modify the mkdocs.yml)
ansible_collections/arista/avd/docs/contribution/authoring_eos_cli_config_gen.md
Outdated
Show resolved
Hide resolved
ansible_collections/arista/avd/docs/contribution/authoring_eos_cli_config_gen.md
Outdated
Show resolved
Hide resolved
ansible_collections/arista/avd/docs/contribution/authoring_eos_cli_config_gen.md
Show resolved
Hide resolved
ansible_collections/arista/avd/docs/contribution/authoring_eos_cli_config_gen.md
Outdated
Show resolved
Hide resolved
ansible_collections/arista/avd/docs/contribution/authoring_eos_cli_config_gen.md
Outdated
Show resolved
Hide resolved
ansible_collections/arista/avd/docs/contribution/authoring_eos_cli_config_gen.md
Outdated
Show resolved
Hide resolved
ansible_collections/arista/avd/docs/contribution/authoring_eos_cli_config_gen.md
Outdated
Show resolved
Hide resolved
ansible_collections/arista/avd/docs/contribution/authoring_eos_cli_config_gen.md
Outdated
Show resolved
Hide resolved
ansible_collections/arista/avd/docs/contribution/authoring_eos_cli_config_gen.md
Outdated
Show resolved
Hide resolved
ansible_collections/arista/avd/docs/contribution/authoring_eos_cli_config_gen.md
Outdated
Show resolved
Hide resolved
9c96f08
to
9553793
Compare
need to review again after last changes
for more information, see https://pre-commit.ci
Co-authored-by: Claus Holbech <[email protected]>
Co-authored-by: Guillaume Mulocher <[email protected]>
9553793
to
885cdcf
Compare
00ffee6
to
117718a
Compare
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.
Great PR, LGTM!
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.
Thanks @Shivani-gslab for this work! very helpful for contributor 🚢
Change Summary
Related Issue(s)
Fixes #3286
Component(s) name
arista.avd.<role-name>
Proposed changes
How to test
Checklist
User Checklist
Repository Checklist