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
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
..
community Formatting and broken links (#35226) 7 years ago
dev_guide Module deprecation: docs, scheme and tests (#34100) 7 years ago
inventory draft implicit localhost docs (#31840) 7 years ago
modules
plugins Fix typo/link in plugins/cache 7 years ago
roadmap doc update (#35214) 7 years ago
YAMLSyntax.rst
become.rst win_become: another option to support become flags for runas (#34551) 7 years ago
command_line_tools.rst Plugin doc update edits for #30490 (#30889) 7 years ago
committer_guidelines.rst No hardcoding roadmaps (#32981) 7 years ago
common_return_values.rst
community.rst Deprecate old community guide (#32266) 7 years ago
conf.py
faq.rst use print function (#34013) 7 years ago
galaxy.rst fix ansible-galaxy requirements.yml import_tasks->include in docs (#34519) 7 years ago
glossary.rst move from with_<lookup>: to loop: 7 years ago
guide_aws.rst move from with_<lookup>: to loop: 7 years ago
guide_azure.rst allow cert validation to be disabled for Azure modules (#34906) 7 years ago
guide_cloudstack.rst Documentation typo fixes (#32473) 7 years ago
guide_docker.rst Documentation typo fixes (#32473) 7 years ago
guide_gce.rst Add 'datacenter' keyword arg to secrets.py (#24598) 7 years ago
guide_kubernetes.rst
guide_packet.rst Fix Packet guide to comply with latest version of the packet module (#31410) 7 years ago
guide_rax.rst move from with_<lookup>: to loop: 7 years ago
guide_rolling_upgrade.rst added note about serial behaviour (#32461) 7 years ago
guide_vagrant.rst
guides.rst
index.rst Moved generated module RSTs to their own directory. (#33966) 7 years ago
intro.rst
intro_adhoc.rst become-user example was incorrect 7 years ago
intro_bsd.rst Add a code-smell test for smart quotes and remove smart quotes from all files 7 years ago
intro_configuration.rst Plugin doc update edits for #30490 (#30889) 7 years ago
intro_dynamic_inventory.rst Update places we mention env vars to use :envvar: (#28887) 7 years ago
intro_getting_started.rst Removing obsolete version behavior callout notes - initial pass. (#33172) 7 years ago
intro_installation.rst Add dnf and yum commands in "Installation" section (#33369) 7 years ago
intro_inventory.rst Fix syntax error in intro_inventory yaml example (#34960) 7 years ago
intro_networking.rst Create network_working_with_command_output.rst (#33709) 7 years ago
intro_patterns.rst Removing obsolete version behavior callout notes - initial pass. (#33172) 7 years ago
intro_windows.rst update Windows docs (#30783) 7 years ago
modules.rst
modules_intro.rst
modules_support.rst Add a code-smell test for smart quotes and remove smart quotes from all files 7 years ago
network_best_practices_2.5.rst Docs network best 2.5 (#33544) 7 years ago
network_debug_troubleshooting.rst Clarify when and how to enable ANSIBLE_DEBUG (#35220) 7 years ago
network_working_with_command_output.rst Create network_working_with_command_output.rst (#33709) 7 years ago
playbook_pathing.rst
playbooks.rst
playbooks_advanced_syntax.rst Removing obsolete version behavior callout notes - initial pass. (#33172) 7 years ago
playbooks_async.rst [Docs] Fix old YAML style in async docs (#31421) 7 years ago
playbooks_best_practices.rst Removing obsolete version behavior callout notes - initial pass. (#33172) 7 years ago
playbooks_blocks.rst Update playbooks_blocks.rst (#31088) 7 years ago
playbooks_checkmode.rst
playbooks_conditionals.rst add documentation around commonly-used Facts for Conditionals (#34263) 7 years ago
playbooks_debugger.rst Provide a way to explicitly invoke the debugger (#34006) 7 years ago
playbooks_delegation.rst Further clarify what determines batch size in a play (#33833) 7 years ago
playbooks_environment.rst
playbooks_error_handling.rst Removing obsolete version behavior callout notes - initial pass. (#33172) 7 years ago
playbooks_filters.rst Improve documentation about Comment filter (#34539) 7 years ago
playbooks_filters_ipaddr.rst
playbooks_intro.rst Removing obsolete version behavior callout notes - initial pass. (#33172) 7 years ago
playbooks_lookups.rst Removing obsolete version behavior callout notes - initial pass. (#33172) 7 years ago
playbooks_loops.rst playbook_loops.rst: fix formatting (#34026) 7 years ago
playbooks_prompts.rst Typo on "Prompts" page (#31882) 7 years ago
playbooks_python_version.rst move from with_<lookup>: to loop: 7 years ago
playbooks_reuse.rst Removing obsolete version behavior callout notes - initial pass. (#33172) 7 years ago
playbooks_reuse_includes.rst updated plugin docs (#30490) 7 years ago
playbooks_reuse_roles.rst Documentation typo fixes (#32473) 7 years ago
playbooks_roles.rst
playbooks_special_topics.rst updated plugin docs (#30490) 7 years ago
playbooks_startnstep.rst consolidated docs 8 years ago
playbooks_strategies.rst Removing obsolete version behavior callout notes - initial pass. (#33172) 7 years ago
playbooks_tags.rst move from with_<lookup>: to loop: 7 years ago
playbooks_templating.rst
playbooks_tests.rst Various doc formatting fixes (#33626) 7 years ago
playbooks_variables.rst Removing obsolete version behavior callout notes - initial pass. (#33172) 7 years ago
playbooks_vault.rst Removing obsolete version behavior callout notes - initial pass. (#33172) 7 years ago
plugin_filtering_config.rst Documentation and changelog for the plugin_filtering config option 7 years ago
plugins.rst Plugin doc update edits for #30490 (#30889) 7 years ago
porting_guide_2.0.rst Add a code-smell test for smart quotes and remove smart quotes from all files 7 years ago
porting_guide_2.3.rst Improve and link Network Proxy docs (#31316) 7 years ago
porting_guide_2.4.rst Add note to 2.4 porting guide about initial playbook relative host/group_vars and inheritance (#34769) 7 years ago
porting_guide_2.5.rst Module deprecation: docs, scheme and tests (#34100) 7 years ago
porting_guides.rst porting_guide_2.5.rst stub (#30311) 7 years ago
python_3_support.rst python_3_support.rst: fix broken links (#33951) 7 years ago
quickstart.rst
release_and_maintenance.rst Update version numbers for the release 7 years ago
test_strategies.rst
tower.rst
vault.rst Small documentation fix in vault.rst (#35384) 7 years ago
windows.rst update Windows docs (#30783) 7 years ago
windows_dsc.rst win_dsc: update documentation for latest DSC changes (#32581) 7 years ago
windows_faq.rst update Windows docs (#30783) 7 years ago
windows_setup.rst Use TEMP variable instead of hardcoded path (#35380) 7 years ago
windows_usage.rst Fixed up windows command quoting example 7 years ago
windows_winrm.rst typo (#34549) 7 years ago