ansible

Commit Graph

Author	SHA1	Message	Date
Scott Butler	5591d639f5	Fixed broken link.	8 years ago
Dylan Silva	9dae697997	Updates to docs for metadata. (#22667 ) * Updates to docs for metadata. * Update developing_modules_documenting.rst	8 years ago
Toshio Kuratomi	eb1214baad	New metadata 1.0 (#22587 ) Changes to the metadata format were approved here: https://github.com/ansible/proposals/issues/54 * Update documentation to the new metadata format * Changes to metadata-tool to account for new metadata * Add GPL license header * Add upgrade subcommand to upgrade metadata version * Change default metadata to the new format * Fix exclusion of non-modules from the metadata report * Fix ansible-doc for new module metadata * Exclude metadata version from ansible-doc output * Fix website docs generation for the new metadata * Update metadata schema in valiate-modules test * Update the metadata in all modules to the new version	8 years ago
John R Barker	04e816e13b	Stricter module documentation validation (#22353 ) 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.	8 years ago
John R Barker	3fa5c55182	Fix docs type (#22405 ) Fix docs typo	8 years ago
John R Barker	3afb67e9b2	Fix Docs build issues (#22295 ) * restore network docs fragments * Fix RST errors * code-block formatting	8 years ago
Toshio Kuratomi	9d85d81ed0	Make the metadata docs agree with what's currently implemented	8 years ago
John R Barker	fdd03916a3	Document ANSIBLE_METADATA (#21250 ) * Document ANSIBLE_METADATA * Formatting * Reive feedback - WIP * notes about Declarative * fix headings * Use field lists * typo * review feedback * Imports * typo * Toshio's feedback	8 years ago
John R Barker	53ac312382	validate-modules --arg-spec (#21331 ) * validate-modules --arg-spec * Update developing_modules_documenting.rst * Never mock out ansible or ansible.module_utils * No more false positives	8 years ago
John R Barker	959637ff59	How to document your module (#21021 ) * How to document your module * Remove blank lines * note:: Versions should be strings * requirements on the host that executes the module. * option names & option values * Feedback * formatting * Scott's final feedback	8 years ago
scottb	13fc909058	Refurbish developing modules content - stage 1 (#20673 ) * Revamping module development docs - work in progress * Refurb of developing modules content continues. * Developing modules refurb work continues * Continued refurb of developing modules content. Work-in-progress. * Ibid * Dev guide content refurb continues - WIP * Ibid. * Removed reference to old extras module repo * Tweaks * Removed some non-intro material; added link to github module PRs. * Incorporated review feedback from @gundalow and @tkuratomi; fixed some links; renamed 'contributing' to 'checklist'	8 years ago

11 Commits (1c61b9bae7dae72b6e7d3f3f2fbb76fda5555552)