You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
ansible/docs/docsite/rst/dev_guide
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()
```
7 years ago
..
style_guide remove erroneous '.' in docsite footer (#34592) 7 years ago
testing Added code-smell check to verify filenames are allowed with Windows (#35436) 7 years ago
Makefile consolidated docs 8 years ago
developing_api.rst Update developing_api.rst to use correct inventory format for single explicit host (#34919) 7 years ago
developing_core.rst consolidated docs 8 years ago
developing_inventory.rst Give example of empty _meta in dyanmic inventory (#24085) 8 years ago
developing_module_utilities.rst Mellanox OS name change: MLNXOS changed to ONYX (#34753) 7 years ago
developing_modules.rst Add docs describing some additional behaviors around modules (#33631) 7 years ago
developing_modules_best_practices.rst Temporary (#31677) 7 years ago
developing_modules_checklist.rst Add a code-smell test for smart quotes and remove smart quotes from all files 7 years ago
developing_modules_documenting.rst Module deprecation: docs, scheme and tests (#34100) 7 years ago
developing_modules_general.rst add prequisites for ubuntu dev env (#30713) 7 years ago
developing_modules_general_OLD._rst rename dev..general_OLD.rst to ._rst (#30291) 7 years ago
developing_modules_general_windows.rst windows dev docs - vagrant info (#33515) 7 years ago
developing_modules_in_groups.rst Fix various RST warnings (#34084) 7 years ago
developing_plugins.rst Change 'connection' to 'inventory' in description 7 years ago
developing_program_flow_modules.rst Fix typo in dev_guide/developing_program_flow_modules 7 years ago
developing_python3.rst Misc docsite fixes (#30290) 7 years ago
developing_rebasing.rst consolidated docs 8 years ago
index.rst Misc docsite fixes (#30290) 7 years ago
overview_architecture.rst Add a code-smell test for smart quotes and remove smart quotes from all files 7 years ago
repomerge.rst Remove references to obsolete PR Mover. (#30298) 7 years ago
testing.rst Mdd module unit test docs (#31373) 7 years ago
testing_compile.rst Convert ansible-test compile into a sanity test. 7 years ago
testing_httptester.rst docs: fix community meetings link (#27264) 7 years ago
testing_integration.rst [cloud] Improve aws testing and use `{{ region }}` var (#26892) 7 years ago
testing_integration_legacy.rst aws integration tests - provide an IAM policy for running (#24725) 8 years ago
testing_pep8.rst docs: fix community meetings link (#27264) 7 years ago
testing_running_locally.rst Mdd module unit test docs (#31373) 7 years ago
testing_sanity.rst Docs how to test (2nd) (#24094) 8 years ago
testing_units.rst Mdd module unit test docs (#31373) 7 years ago
testing_units_modules.rst dev_guide: format code in testing_units_modules.rst (#33009) 7 years ago
testing_validate-modules.rst Module deprecation: docs, scheme and tests (#34100) 7 years ago