community.general/lib/ansible/modules/network/cumulus
John R Barker a23c95023b
Module deprecation: docs, scheme and tests (#34100)
Enforce module deprecation.
After module has reached the end of it's deprecation cycle we will replace it with a docs stub.

* Replace deprecated modules with docs-only sub
* Use of deprecated past deprecation cycle gives meaningful message (see examples below)
* Enforce documentation.deprecation dict via `schema.py`
* Update `ansible-doc` and web docs to display documentation.deprecation
* Document that structure in `dev_guide`
* Ensure that all modules starting with `_` have a `deprecation:` block
* Ensure `deprecation:` block is only used on modules that start with `_`
* `removed_in` A string which represents when this module needs **deleting**
* CHANGELOG.md and porting_guide_2.5.rst list removed modules as well as alternatives
* CHANGELOG.md links to porting guide index

To ensure that meaningful messages are given to the user if they try to use a module at the end of it's deprecation cycle we enforce the module to contain:
```python
if __name__ == '__main__':
    removed_module()
```
2018-01-30 12:23:52 +00:00
..
__init__.py
_cl_bond.py Module deprecation: docs, scheme and tests (#34100) 2018-01-30 12:23:52 +00:00
_cl_bridge.py Module deprecation: docs, scheme and tests (#34100) 2018-01-30 12:23:52 +00:00
_cl_img_install.py Module deprecation: docs, scheme and tests (#34100) 2018-01-30 12:23:52 +00:00
_cl_interface.py Module deprecation: docs, scheme and tests (#34100) 2018-01-30 12:23:52 +00:00
_cl_interface_policy.py Module deprecation: docs, scheme and tests (#34100) 2018-01-30 12:23:52 +00:00
_cl_license.py Module deprecation: docs, scheme and tests (#34100) 2018-01-30 12:23:52 +00:00
_cl_ports.py Module deprecation: docs, scheme and tests (#34100) 2018-01-30 12:23:52 +00:00
nclu.py Bulk autopep8 (modules) 2017-12-07 20:25:55 +00:00