mirror of https://github.com/ansible/ansible.git
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.
04e816e13b
Raise the bar for module `DOCUMENTAION` This validator update was used to find the issues in https://github.com/ansible/ansible/pull/22297/files **Validation** * Updated Validation and docs to enforce more (items fixed in https://github.com/ansible/ansible/pull/22297/files) * Use `suboptions` to document complex options * Validate module name * Validate deprecated modules have correct ANSIBLE_METADATA **Module Documentation Generation** * Document `suboptions:` Example https://gist.github.com/gundalow/4bdc3669d696268328ccc18528cc6718 * Tidy up HTML generation (valid HTML, no empty lists, etc) **Documentation** * Clarify the steps for deprecating a module * Use correct RST headings * Document `suboptions:` (options) * Document `contains:` (returns) **Details** The aim is to get this (and corresponding module updates) complete by the time `devel` becomes `2.4`, as this allows us to raise the bar for new modules Example `suboptions` https://gist.github.com/gundalow/4bdc3669d696268328ccc18528cc6718 The aim is to get this PR integrated into `devel` *before* we branch `stable-2.3`, this will allows us to: * Raise the bar for new modules in 2.4 * Ensure the generated module documentation for 2.3 and higher is improved, important as we will be doing versioned docs moving forward. |
9 years ago | |
|---|---|---|
| .. | ||
| dev_guide | 9 years ago | |
| modules | 9 years ago | |
| roadmap | 9 years ago | |
| YAMLSyntax.rst | 9 years ago | |
| become.rst | 9 years ago | |
| committer_guidelines.rst | 9 years ago | |
| common_return_values.rst | 9 years ago | |
| community.rst | 9 years ago | |
| conf.py | 9 years ago | |
| faq.rst | 9 years ago | |
| galaxy.rst | 9 years ago | |
| glossary.rst | 9 years ago | |
| guide_aws.rst | 9 years ago | |
| guide_azure.rst | 9 years ago | |
| guide_cloudstack.rst | 9 years ago | |
| guide_docker.rst | 9 years ago | |
| guide_gce.rst | 9 years ago | |
| guide_rax.rst | 9 years ago | |
| guide_rolling_upgrade.rst | 9 years ago | |
| guide_vagrant.rst | 9 years ago | |
| guides.rst | 9 years ago | |
| index.rst | 9 years ago | |
| intro.rst | 9 years ago | |
| intro_adhoc.rst | 9 years ago | |
| intro_bsd.rst | 9 years ago | |
| intro_configuration.rst | 9 years ago | |
| intro_dynamic_inventory.rst | 9 years ago | |
| intro_getting_started.rst | 9 years ago | |
| intro_installation.rst | 9 years ago | |
| intro_inventory.rst | 9 years ago | |
| intro_networking.rst | 9 years ago | |
| intro_patterns.rst | 9 years ago | |
| intro_windows.rst | 9 years ago | |
| modules.rst | 9 years ago | |
| modules_intro.rst | 9 years ago | |
| modules_support.rst | 9 years ago | |
| playbooks.rst | 9 years ago | |
| playbooks_acceleration.rst | 9 years ago | |
| playbooks_advanced_syntax.rst | 9 years ago | |
| playbooks_async.rst | 9 years ago | |
| playbooks_best_practices.rst | 9 years ago | |
| playbooks_blocks.rst | 9 years ago | |
| playbooks_checkmode.rst | 9 years ago | |
| playbooks_conditionals.rst | 9 years ago | |
| playbooks_debugger.rst | 9 years ago | |
| playbooks_delegation.rst | 9 years ago | |
| playbooks_environment.rst | 9 years ago | |
| playbooks_error_handling.rst | 9 years ago | |
| playbooks_filters.rst | 9 years ago | |
| playbooks_filters_ipaddr.rst | 9 years ago | |
| playbooks_intro.rst | 9 years ago | |
| playbooks_lookups.rst | 9 years ago | |
| playbooks_loops.rst | 9 years ago | |
| playbooks_prompts.rst | 9 years ago | |
| playbooks_roles.rst | 9 years ago | |
| playbooks_special_topics.rst | 9 years ago | |
| playbooks_startnstep.rst | 9 years ago | |
| playbooks_strategies.rst | 9 years ago | |
| playbooks_tags.rst | 9 years ago | |
| playbooks_templating.rst | 9 years ago | |
| playbooks_tests.rst | 9 years ago | |
| playbooks_variables.rst | 9 years ago | |
| playbooks_vault.rst | 9 years ago | |
| porting_guide_2.0.rst | 9 years ago | |
| python_3_support.rst | 9 years ago | |
| quickstart.rst | 9 years ago | |
| test_strategies.rst | 9 years ago | |
| tower.rst | 9 years ago | |