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

Feat: Improve cv_validate documentation #690

Open
1 task done
pmprado opened this issue Jan 9, 2024 · 0 comments
Open
1 task done

Feat: Improve cv_validate documentation #690

pmprado opened this issue Jan 9, 2024 · 0 comments
Assignees
Labels
help wanted Extra attention is needed type: documentation Improvements or additions to documentation
Milestone

Comments

@pmprado
Copy link

pmprado commented Jan 9, 2024

Enhancement summary

The documentation of this module seems targeted to devs that already know why and what they need this module for.
An use case and a brief working example would be really helpful when evaluating if this is the best API call to use.

Which component of AVD is impacted

cv_device_v3

Use case example

Customer wants to be able to see the changes that would result, right from the AVD run, without modifying the configlets on CV.

Describe the solution you'd like

Using my use case as a guide, show a configlet with the current config, a new config generated by AVD, the playbook run and the result.

Describe alternatives you've considered

Manually pulling all the configlet contents and running a local diff

Additional context

No response

Code of Conduct

  • I agree to follow this project's Code of Conduct
@pmprado pmprado added the type: enhancement New feature or request label Jan 9, 2024
@sugetha24 sugetha24 added the help wanted Extra attention is needed label Jan 31, 2024
@sugetha24 sugetha24 added type: documentation Improvements or additions to documentation and removed type: enhancement New feature or request labels Feb 16, 2024
@sugetha24 sugetha24 added this to the v3.11.0 milestone Feb 16, 2024
@sugetha24 sugetha24 self-assigned this Mar 4, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
help wanted Extra attention is needed type: documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

2 participants