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: Adding contribution guide for eos_cli_config_gen #4730

Merged
merged 20 commits into from
Jan 10, 2025

Conversation

Shivani-gslab
Copy link
Contributor

@Shivani-gslab Shivani-gslab commented Nov 15, 2024

Change Summary

Related Issue(s)

Fixes #3286

Component(s) name

arista.avd.<role-name>

Proposed changes

How to test

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)

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

@github-actions github-actions bot added the type: documentation Improvements or additions to documentation label Nov 15, 2024
@Shivani-gslab Shivani-gslab marked this pull request as ready for review November 19, 2024 11:42
@Shivani-gslab Shivani-gslab requested review from a team as code owners November 19, 2024 11:42
MaheshGSLAB
MaheshGSLAB previously approved these changes Nov 25, 2024
Copy link
Contributor

@MaheshGSLAB MaheshGSLAB left a comment

Choose a reason for hiding this comment

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

LGTM

@gmuloc gmuloc added the one approval This PR has one approval and is only missing one more. label Nov 25, 2024
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.

I would add some general notes in some places stating

  1. 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)
  2. 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)

@Shivani-gslab Shivani-gslab marked this pull request as draft November 26, 2024 05:22
@carlbuchmann carlbuchmann removed the one approval This PR has one approval and is only missing one more. label Nov 26, 2024
mkdocs.yml Outdated Show resolved Hide resolved
mkdocs.yml Outdated Show resolved Hide resolved
mkdocs.yml Show resolved Hide resolved
@Shivani-gslab Shivani-gslab marked this pull request as ready for review November 27, 2024 13:05
@gmuloc gmuloc dismissed MaheshGSLAB’s stale review December 11, 2024 08:36

need to review again after last changes

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.

Great PR, 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.

Thanks @Shivani-gslab for this work! very helpful for contributor 🚢

@gmuloc gmuloc merged commit 3098bb3 into aristanetworks:devel Jan 10, 2025
43 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.

Doc: Improve contribution guide
5 participants