cmueller/ansible
1
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity
ansible/docs/docsite/rst/plugins/plugins.rst

43 lines
1.1 KiB
ReStructuredText
Raw Normal View History

Doc build warning/broken link clean-a-palooza (#37382) * Doc build warning/broken link clean-a-palooza, WIP commit 1. * Fixed broken anchor * Fixing additional broken links; converting from doc to ref. * Fix anchor
2018-03-14 20:44:21 +01:00
.. _plugins_lookup:
Core Docs Refactor and Redesign (#36067) * Docs refactor as outlined in https://github.com/ansible/proposals/issues/79. Moves content into 'guides'; refactors TOC; fixes CSS; design tweaks to layout and CSS; fixes generated plugin, CLI and module docs to fix links accodingly; more. * Adding extra blank line for shippable
2018-02-13 16:23:55 +01:00
********************
Working With Plugins
********************
updated plugin docs (#30490) * updated docs - for devs: - added inventory/vars section - made some updates to general section and other plugin types - for users: - added 'user' plugin section to start describing the plugins - docs on types, what they are and how to use - removed ref to deleted AUTHORS file - corrected several typos/headers - added descriptions to config.rst template - ignore generated files for cli/plugins and config - remove new generated files on `make clean` - moved details from devguid and intro doc to plugin specific pages - pretied up lookup notes - changed precedence ref to not conflict config - removed duplicate config data, as config is autogenerated and up to date - put new plugins under playbooks - added `pass` cause rst/python dislikes fractions - removed dupe in .gitignore, alpha sorted to avoid moar dupes - added try cause rst/python freaks out * generate plugins into their own dir only do plugins that support docs use toctree from main plugins page
2017-09-23 05:19:50 +02:00
Core Docs Refactor and Redesign (#36067) * Docs refactor as outlined in https://github.com/ansible/proposals/issues/79. Moves content into 'guides'; refactors TOC; fixes CSS; design tweaks to layout and CSS; fixes generated plugin, CLI and module docs to fix links accodingly; more. * Adding extra blank line for shippable
2018-02-13 16:23:55 +01:00
Plugins are pieces of code that augment Ansible's core functionality. Ansible uses a plugin architecture to enable a rich, flexible and expandable feature set.
Plugin doc update edits for #30490 (#30889) * Edit pass 1 for #30490 - command line tools and developing plugins. * Continuing edit pass for #30490. WIP * Last round of copy edits for #30490.
2017-09-26 00:37:33 +02:00
updated plugin docs (#30490) * updated docs - for devs: - added inventory/vars section - made some updates to general section and other plugin types - for users: - added 'user' plugin section to start describing the plugins - docs on types, what they are and how to use - removed ref to deleted AUTHORS file - corrected several typos/headers - added descriptions to config.rst template - ignore generated files for cli/plugins and config - remove new generated files on `make clean` - moved details from devguid and intro doc to plugin specific pages - pretied up lookup notes - changed precedence ref to not conflict config - removed duplicate config data, as config is autogenerated and up to date - put new plugins under playbooks - added `pass` cause rst/python dislikes fractions - removed dupe in .gitignore, alpha sorted to avoid moar dupes - added try cause rst/python freaks out * generate plugins into their own dir only do plugins that support docs use toctree from main plugins page
2017-09-23 05:19:50 +02:00
Ansible ships with a number of handy plugins, and you can easily write your own.
Plugin doc update edits for #30490 (#30889) * Edit pass 1 for #30490 - command line tools and developing plugins. * Continuing edit pass for #30490. WIP * Last round of copy edits for #30490.
2017-09-26 00:37:33 +02:00
This section covers the various types of plugins that are included with Ansible:
updated plugin docs (#30490) * updated docs - for devs: - added inventory/vars section - made some updates to general section and other plugin types - for users: - added 'user' plugin section to start describing the plugins - docs on types, what they are and how to use - removed ref to deleted AUTHORS file - corrected several typos/headers - added descriptions to config.rst template - ignore generated files for cli/plugins and config - remove new generated files on `make clean` - moved details from devguid and intro doc to plugin specific pages - pretied up lookup notes - changed precedence ref to not conflict config - removed duplicate config data, as config is autogenerated and up to date - put new plugins under playbooks - added `pass` cause rst/python dislikes fractions - removed dupe in .gitignore, alpha sorted to avoid moar dupes - added try cause rst/python freaks out * generate plugins into their own dir only do plugins that support docs use toctree from main plugins page
2017-09-23 05:19:50 +02:00
Refine plugin docs (#49324) * local TOCs, anchors, better headings, :ref:-not-:doc: links on all plugin pages
2018-11-29 21:03:00 +01:00
.. toctree::
Core Docs Refactor and Redesign (#36067) * Docs refactor as outlined in https://github.com/ansible/proposals/issues/79. Moves content into 'guides'; refactors TOC; fixes CSS; design tweaks to layout and CSS; fixes generated plugin, CLI and module docs to fix links accodingly; more. * Adding extra blank line for shippable
2018-02-13 16:23:55 +01:00
:maxdepth: 1
action
cache
callback
Document httpapi and cliconf plugins (#49503) * Create new documentation pages for httpapi and cliconf * Add new documentation to plugins toctree and Makefile * Add DOCUMENTATION to cliconf * Apply suggestions from code review
2019-02-08 17:04:05 +01:00
cliconf
Core Docs Refactor and Redesign (#36067) * Docs refactor as outlined in https://github.com/ansible/proposals/issues/79. Moves content into 'guides'; refactors TOC; fixes CSS; design tweaks to layout and CSS; fixes generated plugin, CLI and module docs to fix links accodingly; more. * Adding extra blank line for shippable
2018-02-13 16:23:55 +01:00
connection
Document httpapi and cliconf plugins (#49503) * Create new documentation pages for httpapi and cliconf * Add new documentation to plugins toctree and Makefile * Add DOCUMENTATION to cliconf * Apply suggestions from code review
2019-02-08 17:04:05 +01:00
httpapi
Core Docs Refactor and Redesign (#36067) * Docs refactor as outlined in https://github.com/ansible/proposals/issues/79. Moves content into 'guides'; refactors TOC; fixes CSS; design tweaks to layout and CSS; fixes generated plugin, CLI and module docs to fix links accodingly; more. * Adding extra blank line for shippable
2018-02-13 16:23:55 +01:00
inventory
lookup
shell
strategy
vars
Fixes more rST errors (#39042) * removes include, avoids duplicate label rST warnings * reduces literal_block errors on playbooks_filters * addresses TOC errors * ref error on modules page * trying ref for list_of_database_modules
2018-04-20 02:02:48 +02:00
../user_guide/playbooks_filters
../user_guide/playbooks_tests
Core Docs Refactor and Redesign (#36067) * Docs refactor as outlined in https://github.com/ansible/proposals/issues/79. Moves content into 'guides'; refactors TOC; fixes CSS; design tweaks to layout and CSS; fixes generated plugin, CLI and module docs to fix links accodingly; more. * Adding extra blank line for shippable
2018-02-13 16:23:55 +01:00
../user_guide/plugin_filtering_config
updated plugin docs (#30490) * updated docs - for devs: - added inventory/vars section - made some updates to general section and other plugin types - for users: - added 'user' plugin section to start describing the plugins - docs on types, what they are and how to use - removed ref to deleted AUTHORS file - corrected several typos/headers - added descriptions to config.rst template - ignore generated files for cli/plugins and config - remove new generated files on `make clean` - moved details from devguid and intro doc to plugin specific pages - pretied up lookup notes - changed precedence ref to not conflict config - removed duplicate config data, as config is autogenerated and up to date - put new plugins under playbooks - added `pass` cause rst/python dislikes fractions - removed dupe in .gitignore, alpha sorted to avoid moar dupes - added try cause rst/python freaks out * generate plugins into their own dir only do plugins that support docs use toctree from main plugins page
2017-09-23 05:19:50 +02:00
.. seealso::
Link fixes (#39038) * fixes links on plugins pages * fixes links in community pages * fixes links in user guide * adds anchors on playbooks pages
2018-04-20 02:02:30 +02:00
:ref:`about_playbooks`
updated plugin docs (#30490) * updated docs - for devs: - added inventory/vars section - made some updates to general section and other plugin types - for users: - added 'user' plugin section to start describing the plugins - docs on types, what they are and how to use - removed ref to deleted AUTHORS file - corrected several typos/headers - added descriptions to config.rst template - ignore generated files for cli/plugins and config - remove new generated files on `make clean` - moved details from devguid and intro doc to plugin specific pages - pretied up lookup notes - changed precedence ref to not conflict config - removed duplicate config data, as config is autogenerated and up to date - put new plugins under playbooks - added `pass` cause rst/python dislikes fractions - removed dupe in .gitignore, alpha sorted to avoid moar dupes - added try cause rst/python freaks out * generate plugins into their own dir only do plugins that support docs use toctree from main plugins page
2017-09-23 05:19:50 +02:00
An introduction to playbooks
Link fixes (#39038) * fixes links on plugins pages * fixes links in community pages * fixes links in user guide * adds anchors on playbooks pages
2018-04-20 02:02:30 +02:00
:ref:`ansible_configuration_settings`
updated plugin docs (#30490) * updated docs - for devs: - added inventory/vars section - made some updates to general section and other plugin types - for users: - added 'user' plugin section to start describing the plugins - docs on types, what they are and how to use - removed ref to deleted AUTHORS file - corrected several typos/headers - added descriptions to config.rst template - ignore generated files for cli/plugins and config - remove new generated files on `make clean` - moved details from devguid and intro doc to plugin specific pages - pretied up lookup notes - changed precedence ref to not conflict config - removed duplicate config data, as config is autogenerated and up to date - put new plugins under playbooks - added `pass` cause rst/python dislikes fractions - removed dupe in .gitignore, alpha sorted to avoid moar dupes - added try cause rst/python freaks out * generate plugins into their own dir only do plugins that support docs use toctree from main plugins page
2017-09-23 05:19:50 +02:00
Ansible configuration documentation and settings
Refine plugin docs (#49324) * local TOCs, anchors, better headings, :ref:-not-:doc: links on all plugin pages
2018-11-29 21:03:00 +01:00
:ref:`command_line_tools`
updated plugin docs (#30490) * updated docs - for devs: - added inventory/vars section - made some updates to general section and other plugin types - for users: - added 'user' plugin section to start describing the plugins - docs on types, what they are and how to use - removed ref to deleted AUTHORS file - corrected several typos/headers - added descriptions to config.rst template - ignore generated files for cli/plugins and config - remove new generated files on `make clean` - moved details from devguid and intro doc to plugin specific pages - pretied up lookup notes - changed precedence ref to not conflict config - removed duplicate config data, as config is autogenerated and up to date - put new plugins under playbooks - added `pass` cause rst/python dislikes fractions - removed dupe in .gitignore, alpha sorted to avoid moar dupes - added try cause rst/python freaks out * generate plugins into their own dir only do plugins that support docs use toctree from main plugins page
2017-09-23 05:19:50 +02:00
Ansible tools, description and options
Prefer https:// links in the docs site All the changed urls are availible by way of https://. Most of them already redirect.
2018-07-21 15:48:47 +02:00
`User Mailing List <https://groups.google.com/group/ansible-devel>`_
updated plugin docs (#30490) * updated docs - for devs: - added inventory/vars section - made some updates to general section and other plugin types - for users: - added 'user' plugin section to start describing the plugins - docs on types, what they are and how to use - removed ref to deleted AUTHORS file - corrected several typos/headers - added descriptions to config.rst template - ignore generated files for cli/plugins and config - remove new generated files on `make clean` - moved details from devguid and intro doc to plugin specific pages - pretied up lookup notes - changed precedence ref to not conflict config - removed duplicate config data, as config is autogenerated and up to date - put new plugins under playbooks - added `pass` cause rst/python dislikes fractions - removed dupe in .gitignore, alpha sorted to avoid moar dupes - added try cause rst/python freaks out * generate plugins into their own dir only do plugins that support docs use toctree from main plugins page
2017-09-23 05:19:50 +02:00
Have a question? Stop by the google group!
`irc.freenode.net <http://irc.freenode.net>`_
#ansible IRC chat channel
Reference in a new issue Copy permalink