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
This commit is contained in:
scottb 2018-02-13 07:23:55 -08:00 committed by GitHub
commit 373b1dcf59
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
157 changed files with 13167 additions and 178 deletions

View file

@ -1,5 +1,9 @@
Action Plugins
---------------
==============
.. contents::
:local:
:depth: 2
Action plugins act in conjunction with :doc:`modules <../modules>` to execute the actions required by playbook tasks.
They usually execute automatically in the background doing prerequisite work before modules execute.
@ -9,17 +13,28 @@ The 'normal' action plugin is used for modules that do not already have an actio
.. _enabling_action:
Enabling Action Plugins
+++++++++++++++++++++++
-----------------------
You can enable a custom action plugin by either dropping it into the ``action_plugins`` directory adjacent to your play, inside a role, or by putting it in one of the action plugin directory sources configured in :doc:`ansible.cfg <../config>`.
.. _using_action:
Using Action Plugins
+++++++++++++++++++++
--------------------
Action plugin are executed by default when an associated module is used; no action is required.
Plugin List
-----------
You can use ``ansible-doc -t cache -l`` to see the list of available plugins.
Use ``ansible-doc -t cache <plugin name>`` to see specific documentation and examples.
.. toctree:: :maxdepth: 1
:glob:
action/*
.. seealso::
:doc:`cache`

View file

@ -0,0 +1,38 @@
********************
Working With Plugins
********************
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.
Ansible ships with a number of handy plugins, and you can easily write your own.
This section covers the various types of plugins that are included with Ansible:
.. toctree::
:maxdepth: 1
action
cache
callback
connection
inventory
lookup
shell
strategy
vars
playbooks_filters
playbooks_tests
../user_guide/plugin_filtering_config
.. seealso::
:doc:`playbooks`
An introduction to playbooks
:doc:`config`
Ansible configuration documentation and settings
:doc:`command_line_tools`
Ansible tools, description and options
`User Mailing List <http://groups.google.com/group/ansible-devel>`_
Have a question? Stop by the google group!
`irc.freenode.net <http://irc.freenode.net>`_
#ansible IRC chat channel

View file

@ -25,17 +25,17 @@ In this case, you will also want to update the :ref:`ansible_executable` to matc
.. seealso::
:doc:`../playbooks`
:doc:`../user_guide/playbooks`
An introduction to playbooks
:doc:`inventory`
Ansible inventory plugins
:doc:`callback`
Ansible callback plugins
:doc:`../playbooks_filters`
:doc:`../user_guide/playbooks_filters`
Jinja2 filter plugins
:doc:`../playbooks_tests`
:doc:`../user_guide/playbooks_tests`
Jinja2 test plugins
:doc:`../playbooks_lookups`
:doc:`../user_guide/playbooks_lookups`
Jinja2 lookup plugins
`User Mailing List <http://groups.google.com/group/ansible-devel>`_
Have a question? Stop by the google group!