Doc: Adding contribution guide for eos_cli_config_gen #4730

Shivani-gslab · 2024-11-15T11:51:14Z

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)

github-actions · 2024-11-15T11:51:25Z

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

for more information, see https://pre-commit.ci

ansible_collections/arista/avd/docs/contribution/authoring_eos_cli_config_gen.md

ClausHolbechArista · 2024-11-19T07:27:31Z

ansible_collections/arista/avd/docs/contribution/authoring_eos_cli_config_gen.md

+
+### Run Pre-commit Checks
+
+Run all pre-commit checks `pre-commit run --all` to ensure that all files added or modified are correctly following the coding standards and formatting rules.


Suggested change

Run all pre-commit checks `pre-commit run --all` to ensure that all files added or modified are correctly following the coding standards and formatting rules.

Run all pre-commit checks `pre-commit run` to ensure that all files added or modified are correctly following the coding standards and formatting rules.

pre-commit run checks staged files only

right. But pre-commit run --all takes forever :)

I see it still reads --all is it expected? (conversation was resolved)

Co-authored-by: Claus Holbech <[email protected]>

MaheshGSLAB · 2024-11-19T12:59:11Z

ansible_collections/arista/avd/docs/contribution/authoring_eos_cli_config_gen.md

+4. **Type Conversion:** Add `convert_types: [str]` for `type: int` keys.
+5. **Defaults:** Avoid using `defaults` in eos_cli_config_gen.
+6. **Min/Max:** Specify min/max values in the schema if they are defined in the EOS CLI.
+


Lets add the the use of required key

ansible_collections/arista/avd/docs/contribution/authoring_eos_cli_config_gen.md

sonarcloud · 2024-11-21T07:40:55Z

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud

MaheshGSLAB

LGTM

gmuloc

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

gmuloc · 2024-11-25T13:30:50Z

ansible_collections/arista/avd/docs/contribution/authoring_eos_cli_config_gen.md

+
+Follow the [Development Tooling Guide](https://avd.arista.com/5.0/docs/contribution/development-tooling.html).
+
+### Schema creation


I would add an overview of whats needed as a list before this like

schema

templates (eos and documentation)

molecule (tests)

Added a list of steps

ansible_collections/arista/avd/docs/contribution/authoring_eos_cli_config_gen.md

gmuloc · 2024-11-25T13:38:13Z

ansible_collections/arista/avd/docs/contribution/authoring_eos_cli_config_gen.md

+### Update Documentation
+
+If the proposed feature requires any changes to the documentation, make sure to update it accordingly.
+If there are any breaking changes introduced, document them in the porting guide.


@ClausHolbechArista / @carlbuchmann - porting guide for major releases / release-notes for minor and maintenance releases?

gmuloc · 2024-11-25T13:38:57Z

ansible_collections/arista/avd/docs/contribution/authoring_eos_cli_config_gen.md

+
+### Run Pre-commit Checks
+
+Run all pre-commit checks `pre-commit run --all` to ensure that all files added or modified are correctly following the coding standards and formatting rules.


I see it still reads --all is it expected? (conversation was resolved)

ansible_collections/arista/avd/docs/contribution/authoring_eos_cli_config_gen.md

gmuloc · 2024-11-25T13:40:54Z

ansible_collections/arista/avd/docs/contribution/authoring_eos_cli_config_gen.md

+6. Ensure that Jinja2 templates follow all the guidelines mentioned above.
+7. Check that the template generates valid configuration and documentation, maintaining the same configuration order and indentation as EOS CLI.
+8. Check out the PR in a local IDE and run all tests to ensure functionality.
+9. Test the generated configuration through EAPI or CVP in the ATD lab.


not everybody may have an ATD lab - you can state in a relevant lab (if availbale otherwise indicate you could not verify in a lab in your review comment.)

Suggested change

9. Test the generated configuration through EAPI or CVP in the ATD lab.

9. Test the generated configuration through EAPI or CVP in the ATD lab.

gmuloc · 2024-11-25T13:41:28Z

ansible_collections/arista/avd/docs/contribution/authoring_eos_cli_config_gen.md

+7. Check that the template generates valid configuration and documentation, maintaining the same configuration order and indentation as EOS CLI.
+8. Check out the PR in a local IDE and run all tests to ensure functionality.
+9. Test the generated configuration through EAPI or CVP in the ATD lab.
+10. If providing code suggestions, test them locally to ensure that your proposals work as intended.


Add something to state to add inline suggestions whenever possible

Co-authored-by: Guillaume Mulocher <[email protected]>

carlbuchmann · 2024-11-26T13:28:15Z

mkdocs.yml

@@ -192,6 +192,7 @@ nav:
  - External Resources:
      - Ansible Collection User Guide: https://docs.ansible.com/ansible/latest/user_guide/collections_using.html
      - Ansible User Guide: https://docs.ansible.com/ansible/latest/user_guide/index.html
+      - Authoring eos_cli_config_gen Role Guide: docs/contribution/authoring_eos_cli_config_gen.md


This should be in the Contributing to AVD: section

Thanks, fixed!

mkdocs.yml

github-actions bot assigned Shivani-gslab Nov 15, 2024

github-actions bot added the type: documentation Improvements or additions to documentation label Nov 15, 2024

Shivani-gslab added 3 commits November 15, 2024 17:21

Doc: Adding contribution guide for eos_cli_config_gen

0df24be

Added review checklist

112a30c

Few modifications

a43aa6d

Shivani-gslab force-pushed the contribution_guide branch from a8fd2f4 to a43aa6d Compare November 15, 2024 11:51

Shivani-gslab requested review from carlbuchmann and gmuloc November 15, 2024 11:54

pre-commit-ci bot and others added 2 commits November 15, 2024 11:54

[pre-commit.ci] auto fixes from pre-commit.com hooks

728d0e5

for more information, see https://pre-commit.ci

Add step for env creation

a3036f1

Shivani-gslab requested a review from ClausHolbechArista November 15, 2024 12:10

Shivani-gslab added 2 commits November 15, 2024 18:12

Fix pre-commit

10722d3

Update schema guidelines

b2e8453

ClausHolbechArista reviewed Nov 19, 2024

View reviewed changes

Shivani-gslab and others added 2 commits November 19, 2024 14:46

Apply suggestions from code review

c92c919

Co-authored-by: Claus Holbech <[email protected]>

Fix comments

49d0f13

Shivani-gslab force-pushed the contribution_guide branch from 48f50f1 to 49d0f13 Compare November 19, 2024 09:33

Shivani-gslab marked this pull request as ready for review November 19, 2024 11:42

Shivani-gslab requested review from a team as code owners November 19, 2024 11:42

MaheshGSLAB reviewed Nov 19, 2024

View reviewed changes

Shivani-gslab added 2 commits November 21, 2024 12:15

Fix comments

a47f498

Remove required key guide

b89cdc0

Shivani-gslab force-pushed the contribution_guide branch from 2ef2650 to b89cdc0 Compare November 21, 2024 07:39

Shivani-gslab requested review from ClausHolbechArista and MaheshGSLAB November 22, 2024 11:18

MaheshGSLAB approved these changes Nov 25, 2024

View reviewed changes

gmuloc added the one approval This PR has one approval and is only missing one more. label Nov 25, 2024

gmuloc requested changes Nov 25, 2024

View reviewed changes

Shivani-gslab marked this pull request as draft November 26, 2024 05:22

Shivani-gslab and others added 3 commits November 26, 2024 11:33

Apply suggestions from code review

44b11d6

Co-authored-by: Guillaume Mulocher <[email protected]>

Fixing review comments

f2dd5a5

updating build schema and documentation step

28b91f8

Shivani-gslab requested review from gmuloc and MaheshGSLAB November 26, 2024 11:09

carlbuchmann removed the one approval This PR has one approval and is only missing one more. label Nov 26, 2024

carlbuchmann reviewed Nov 26, 2024

View reviewed changes

Shivani-gslab commented Nov 26, 2024

View reviewed changes

mkdocs.yml Outdated Show resolved Hide resolved

mkdocs.yml Show resolved Hide resolved

updating mkdocs.yml

eb32596

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Doc: Adding contribution guide for eos_cli_config_gen #4730

Doc: Adding contribution guide for eos_cli_config_gen #4730

Shivani-gslab commented Nov 15, 2024 •

edited

Loading

github-actions bot commented Nov 15, 2024

ClausHolbechArista Nov 19, 2024

Shivani-gslab Nov 19, 2024

ClausHolbechArista Nov 19, 2024

gmuloc Nov 25, 2024

MaheshGSLAB Nov 19, 2024

sonarcloud bot commented Nov 21, 2024

MaheshGSLAB left a comment

gmuloc left a comment

gmuloc Nov 25, 2024

Shivani-gslab Nov 26, 2024

gmuloc Nov 25, 2024

gmuloc Nov 25, 2024

gmuloc Nov 25, 2024

Shivani-gslab Nov 26, 2024

gmuloc Nov 25, 2024

Shivani-gslab Nov 26, 2024

carlbuchmann Nov 26, 2024

Shivani-gslab Nov 26, 2024


		### Run Pre-commit Checks

		Run all pre-commit checks `pre-commit run --all` to ensure that all files added or modified are correctly following the coding standards and formatting rules.


		Follow the [Development Tooling Guide](https://avd.arista.com/5.0/docs/contribution/development-tooling.html).

		### Schema creation

	9. Test the generated configuration through EAPI or CVP in the ATD lab.
	9. Test the generated configuration through EAPI or CVP in the ATD lab.

Doc: Adding contribution guide for eos_cli_config_gen #4730

Are you sure you want to change the base?

Doc: Adding contribution guide for eos_cli_config_gen #4730

Conversation

Shivani-gslab commented Nov 15, 2024 • edited Loading

Change Summary

Related Issue(s)

Component(s) name

Proposed changes

How to test

Checklist

User Checklist

Repository Checklist

github-actions bot commented Nov 15, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

sonarcloud bot commented Nov 21, 2024

Quality Gate passed

MaheshGSLAB left a comment

Choose a reason for hiding this comment

gmuloc left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Shivani-gslab commented Nov 15, 2024 •

edited

Loading