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: Contribution Guide Updates #3766

Conversation

carlbuchmann
Copy link
Member

@carlbuchmann carlbuchmann commented Mar 23, 2024

Change Summary

  • Clean up the contribution guide overview and remove outdated content.
  • Created a specific development tooling guide.
  • Updated links and container description in collection-installation.md
  • updated root Makefile:
    • update descriptions
    • removed unused documentation targets
  • Updated descriptions in pre-commit-config.yml.
  • updates molecule/Makefile
    • improved descriptions
    • remove git and cleanup targets

Remove unused/legacy content

  • Dockerfile
  • development/Makefile
  • development/README.md
  • development/docker-stack.env
  • development/install.sh
  • symlinks to requirements

Task List

  • Cleanup outdated documentation
  • document developing tooling
    • dev container
    • python environment
    • pre-commit
    • molecule
    • ansible-test
    • tox

Note: The Dev Container doesn't support running any test that requires docker, tracked in issue #4052

@carlbuchmann carlbuchmann requested review from a team as code owners March 23, 2024 02:04
@github-actions github-actions bot added the type: documentation Improvements or additions to documentation label Mar 23, 2024
@carlbuchmann carlbuchmann marked this pull request as draft March 23, 2024 02:05
@github-actions github-actions bot added the state: conflict PR with conflict label Apr 17, 2024
Copy link

This pull request has conflicts, please resolve those before we can evaluate the pull request.

Copy link
Contributor

@pmprado pmprado left a comment

Choose a reason for hiding this comment

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

Are we going to create other versions of the deleted files, or is the goal to actually shrink and focus only on AVD-specific things?
Also, we should mention the minimum python version for development somewhere.

@carlbuchmann carlbuchmann force-pushed the doc-contribution-guide-improvements branch from bef9f56 to 78c086f Compare May 27, 2024 13:40
@github-actions github-actions bot removed the state: conflict PR with conflict label May 27, 2024
Copy link

Conflicts have been resolved. A maintainer will review the pull request shortly.

@github-actions github-actions bot added the state: CI Updated CI scenario have been updated in the PR label May 28, 2024
@github-actions github-actions bot added type: dependencies Pull requests that update a dependency file role: eos_config_deploy_cvp issue related to eos_config_deploy_cvp role type: code quality CI and development toolset state: Documentation role Updated labels May 28, 2024
@carlbuchmann carlbuchmann requested a review from pmprado May 28, 2024 23:31
@carlbuchmann carlbuchmann marked this pull request as ready for review May 29, 2024 20:22
Makefile Outdated
@@ -44,24 +44,24 @@ pyavd-editable-install: ## Build and install PyAVD as editable
#########################################

.PHONY: sanity
sanity: sanity-info sanity-lint sanity-import ## Run ansible-test sanity validation.
sanity: sanity-info sanity-lint sanity-import ## Run ansible-test sanity validation. Requires docker.
Copy link
Contributor

Choose a reason for hiding this comment

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

Is this still correct? Since you changed the default to venv.

Copy link
Member Author

@carlbuchmann carlbuchmann May 30, 2024

Choose a reason for hiding this comment

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

this target runs all 3 targets sanity-info sanity-lint sanity-import and sanity-info requires docker. I will also update this and the document and makefile.

Copy link
Member Author

Choose a reason for hiding this comment

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

nvm this comment, need more coffee this morning you are correct that we no longer require docker to run this!

Copy link
Member Author

Choose a reason for hiding this comment

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

resolved with 69afeed

Copy link

sonarcloud bot commented May 31, 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

@carlbuchmann carlbuchmann merged commit 1c00222 into aristanetworks:devel May 31, 2024
37 of 39 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
rn: Doc role: eos_config_deploy_cvp issue related to eos_config_deploy_cvp role state: CI Updated CI scenario have been updated in the PR state: Documentation role Updated type: code quality CI and development toolset type: dependencies Pull requests that update a dependency file type: documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants