cmueller/ansible
1
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity

Document the ability to deprecate by date (#69833)

Browse source 
* Document the ability to deprecate by date
* deprecated_in and deprecated_by_date are mutually exclusive
This commit is contained in:
Sandra McCann 2020-06-11 16:28:24 -04:00 committed by GitHub
parent f5df702b55
commit 524257a7b0
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 2 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

3
docs/docsite/rst/dev_guide/module_lifecycle.rst
View file

@ -27,7 +27,8 @@ To deprecate a module, you must:
3. Reference the deprecation in the relevant ``porting_guide_x.y.rst``.
4. Add ``deprecated:`` to the documentation with the following sub-values:
:removed_in: A ``string``, such as ``"2.10"``; the version of Ansible where the module will be replaced with a docs-only module stub. Usually current release +4.
:removed_in: A ``string``, such as ``"2.10"``; the version of Ansible where the module will be replaced with a docs-only module stub. Usually current release +4. Mutually exclusive with :removed_by_date:.
:remove_by_date: (Added in Ansible 2.10). An ISO 8601 formatted date when the module will be removed. Usually 2 years from the date the module is deprecated. Mutually exclusive with :removed_in:.
:why: Optional string that used to detail why this has been removed.
:alternative: Inform users they should do instead, i.e. ``Use M(whatmoduletouseinstead) instead.``.