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 | |
|---|---|---|
| .. | ||
| Makefile | 9 years ago | |
| conf.py | 9 years ago | |
| developing_api.rst | 9 years ago | |
| developing_core.rst | 9 years ago | |
| developing_inventory.rst | 9 years ago | |
| developing_module_utilities.rst | 9 years ago | |
| developing_modules.rst | 9 years ago | |
| developing_modules_best_practices.rst | 9 years ago | |
| developing_modules_checklist.rst | 9 years ago | |
| developing_modules_documenting.rst | 9 years ago | |
| developing_modules_general.rst | 9 years ago | |
| developing_modules_in_groups.rst | 9 years ago | |
| developing_modules_python3.rst | 9 years ago | |
| developing_plugins.rst | 9 years ago | |
| developing_program_flow_modules.rst | 9 years ago | |
| developing_rebasing.rst | 9 years ago | |
| developing_releases.rst | 9 years ago | |
| developing_test_pr.rst | 9 years ago | |
| index.rst | 9 years ago | |
| overview_architecture.rst | 9 years ago | |
| repomerge.rst | 9 years ago | |