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: Announce deprecation of arista.cvp v1 modules #429

Merged
merged 1 commit into from
Jan 4, 2022
Merged

Doc: Announce deprecation of arista.cvp v1 modules #429

merged 1 commit into from
Jan 4, 2022

Conversation

titom73
Copy link
Contributor

@titom73 titom73 commented Dec 14, 2021

Change Summary

Announce arista.cvp.cv_* v1 deprecation

Related Issue(s)

N/A

Component(s) name

  • arista.cvp.cv_facts
  • arista.cvp.cv_container
  • arista.cvp.cv_configlet
  • arista.cvp.cv_device
  • arista.cvp.cv_task

Proposed changes

Mark modules as deprecated in module documentation

How to test

$ ansible-doc arista.cvp.cv_container

        CloudVision Portal Configlet configuration requires a dictionary of containers with their parent, to create and delete
        containers on CVP side. Returns number of created and/or deleted containers

ADDED IN: version 1.0.0 of arista.cvp

DEPRECATED: 

        Reason: Updated modules released with increased functionality
        Will be removed in: Ansible 4.0
        Alternatives: Use M(arista.cvp.cv_container_v3) instead.

[...]

Checklist

User Checklist

  • Update Makefile to stop regenerate v1 documentation
  • Update Readmes
  • Mark all modules as deprecated

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. (check the box if not applicable)
  • I have updated molecule CI testing accordingly. (check the box if not applicable)

@github-actions github-actions bot added module: cv_configlet Issue related to cv_configlet module module: cv_container Issue related to cv_container module module: cv_device Issue related to cv_device module module: cv_facts Issue related to cv_facts module module: cv_task Issue related to cv_task module type: documentation Improvements or additions to documentation labels Dec 14, 2021
@titom73 titom73 changed the title Docs: Announce deprecation of arista.cvp v1 modules Doc: Announce deprecation of arista.cvp v1 modules Dec 14, 2021
@titom73 titom73 marked this pull request as ready for review December 14, 2021 18:15
@titom73 titom73 merged commit 8bb0957 into aristanetworks:devel Jan 4, 2022
@titom73 titom73 deleted the features/deprecate-v1-modules branch January 4, 2022 10:00
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
module: cv_configlet Issue related to cv_configlet module module: cv_container Issue related to cv_container module module: cv_device Issue related to cv_device module module: cv_facts Issue related to cv_facts module module: cv_task Issue related to cv_task module type: documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant