mirror of
https://github.com/ansible-collections/community.general.git
synced 2026-05-07 22:02:50 +00: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
This commit is contained in:
33
docs/templates/config.rst.j2
vendored
33
docs/templates/config.rst.j2
vendored
@@ -6,9 +6,42 @@
|
||||
{{name}}
|
||||
{{ '=' * name_len }}
|
||||
|
||||
Ansible supports a few ways of providing configuration variables, mainly through environment variables, command line switches and an ini file `ansible.cfg`.
|
||||
|
||||
Starting at Ansible 2.4 the `ansible-config` utility allows users to see all the configuration settings available, their defaults, how to set them and
|
||||
where their current value comes from. See :doc:ansible-config for more information.
|
||||
|
||||
|
||||
The configuration file
|
||||
======================
|
||||
|
||||
Changes can be made and used in a configuration file which will be searched for in the following order::
|
||||
|
||||
* ANSIBLE_CONFIG (environment variable if set)
|
||||
* ansible.cfg (in the current directory)
|
||||
* ~/.ansible.cfg (in the home directory)
|
||||
* /etc/ansible/ansible.cfg
|
||||
|
||||
Ansible will process the above list and use the first file found, all others are ignored.
|
||||
|
||||
.. note:: Comments
|
||||
The configuration file is one variant of an INI format.
|
||||
Both the hash sign ("#") and semicolon (";") are allowed as
|
||||
comment markers when the comment starts the line.
|
||||
However, if the comment is inline with regular values,
|
||||
only the semicolon is allowed to introduce the comment.
|
||||
For instance::
|
||||
|
||||
# some basic default values...
|
||||
inventory = /etc/ansible/hosts ; This points to the file that lists your hosts
|
||||
|
||||
|
||||
Common Options
|
||||
==============
|
||||
|
||||
This is a copy of the options available from our release, your local install might have extra options due to additional plugins,
|
||||
you can use the command line utility mentioned above (`ansible-config`) to browse through those.
|
||||
|
||||
{% if config_options %}
|
||||
|
||||
|
||||
|
||||
1
docs/templates/man.j2
vendored
1
docs/templates/man.j2
vendored
@@ -104,7 +104,6 @@ AUTHOR
|
||||
------
|
||||
|
||||
Ansible was originally written by Michael DeHaan.
|
||||
See the AUTHORS file for a complete list of contributors.
|
||||
|
||||
|
||||
COPYRIGHT
|
||||
|
||||
Reference in New Issue
Block a user