valitydev/salt
14
0
Fork 0
mirror of https://github.com/valitydev/salt.git synced 2024-11-08 01:18:58 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Make configuration docs easier to read

Browse Source
This commit is contained in:
rallytime 2016-03-10 20:59:40 -07:00
parent 02e67c44ee
commit cf0b2df8e9
1 changed files with 16 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

28
salt/modules/github.py
View File

@ -4,21 +4,25 @@ Module for interacting with the GitHub v3 API.
.. versionadded:: 2016.3.0.
:depends: - PyGithub python module
:configuration: Configure this module by specifying the name of a configuration
profile in the minion config, minion pillar, or master config. The module
will use the 'github' key by default, if defined.
:depends: PyGithub python module
For example:
Configuration
-------------
.. code-block:: yaml
Configure this module by specifying the name of a configuration
profile in the minion config, minion pillar, or master config. The module
will use the 'github' key by default, if defined.
github:
token: abc1234
org_name: my_organization
# optional: only some functions, such as 'add_user',
# require a dev_team_id
dev_team_id: 1234
For example:
.. code-block:: yaml
github:
token: abc1234
org_name: my_organization
# optional: only some functions, such as 'add_user',
# require a dev_team_id
dev_team_id: 1234
'''
# Import python libs