mirror of
https://github.com/ansible-collections/community.general.git
synced 2024-09-14 20:13:21 +02:00
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. |
||
|---|---|---|
| .. | ||
| conf.py | ||
| developing_api.rst | ||
| developing_core.rst | ||
| developing_inventory.rst | ||
| developing_module_utilities.rst | ||
| developing_modules.rst | ||
| developing_modules_best_practices.rst | ||
| developing_modules_checklist.rst | ||
| developing_modules_documenting.rst | ||
| developing_modules_general.rst | ||
| developing_modules_in_groups.rst | ||
| developing_modules_python3.rst | ||
| developing_plugins.rst | ||
| developing_program_flow_modules.rst | ||
| developing_rebasing.rst | ||
| developing_releases.rst | ||
| developing_test_pr.rst | ||
| index.rst | ||
| Makefile | ||
| overview_architecture.rst | ||
| repomerge.rst | ||