diff --git a/doc/ref/configuration/minion.rst b/doc/ref/configuration/minion.rst index de128d43c5..de082d31ea 100644 --- a/doc/ref/configuration/minion.rst +++ b/doc/ref/configuration/minion.rst @@ -726,7 +726,7 @@ directed to look on the minion by setting this parameter to ``local``. .. conf_minion:: use_master_when_local ``use_master_when_local`` ---------------- +------------------------- Default: ``False`` diff --git a/doc/topics/development/modular_systems.rst b/doc/topics/development/modular_systems.rst index e330260906..fa2c23e842 100644 --- a/doc/topics/development/modular_systems.rst +++ b/doc/topics/development/modular_systems.rst @@ -82,6 +82,7 @@ This provides a console that has access to all the vars and functions, and even supports tab-completion. .. code-block:: python + print(test) test123 diff --git a/doc/topics/development/tests/index.rst b/doc/topics/development/tests/index.rst index 846a64af8d..8471e1d15e 100644 --- a/doc/topics/development/tests/index.rst +++ b/doc/topics/development/tests/index.rst @@ -43,8 +43,7 @@ specific groups of tests or individual tests: * Run unit and integration tests for states: ``./tests/runtests.py --state`` * Run integration tests for an individual module: ``./tests/runtests.py -n integration.modules.virt`` * Run unit tests for an individual module: ``./tests/runtests.py -n unit.modules.virt_test`` -* Run an individual test by using the class and test name (this example is for the ``test_default_kvm_profile`` test in the -``integration.module.virt``): ``./tests/runtests.py -n ingtegration.module.virt.VirtTest.test_default_kvm_profile`` +* Run an individual test by using the class and test name (this example is for the ``test_default_kvm_profile`` test in the ``integration.module.virt``): ``./tests/runtests.py -n ingtegration.module.virt.VirtTest.test_default_kvm_profile`` Running Unit Tests Without Integration Test Daemons diff --git a/doc/topics/event/index.rst b/doc/topics/event/index.rst index 4bca05b09d..4e345597ed 100644 --- a/doc/topics/event/index.rst +++ b/doc/topics/event/index.rst @@ -113,6 +113,7 @@ If a process is listening on the minion, it may be useful for a user on the master to fire an event to it: .. code-block:: python + # Job on minion import salt.utils.event diff --git a/doc/topics/releases/2014.7.0.rst b/doc/topics/releases/2014.7.0.rst index d5253f427b..b71d5a9e50 100644 --- a/doc/topics/releases/2014.7.0.rst +++ b/doc/topics/releases/2014.7.0.rst @@ -347,7 +347,7 @@ request. As an example, Amazon or GitHub requests are signed this way. Generating and Accepting Minion Keys ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -The :py:method:`/key ` convenience URL +The :py:func:`/key ` convenience URL generates a public and private key for a minion, automatically pre-accepts the public key on the Salt Master, and returns both keys as a tarball for download. diff --git a/doc/topics/troubleshooting/index.rst b/doc/topics/troubleshooting/index.rst index 91086c097a..3d42737205 100644 --- a/doc/topics/troubleshooting/index.rst +++ b/doc/topics/troubleshooting/index.rst @@ -10,18 +10,24 @@ Troubleshooting the Salt Master =============================== If your Salt master is having issues such as minions not returning data, slow -execution times, or a variety of other issues the -:doc:`Salt master troubleshooting page -` contains details on troubleshooting the most -common issues encountered. +execution times, or a variety of other issues, the following links contain +details on troubleshooting the most common issues encountered: + +.. toctree:: + :maxdepth: 2 + + master Troubleshooting the Salt Minion =============================== -In the event that your Salt minion is having issues a variety of solutions -and suggestions are available at the :doc:`Salt minion troubleshooting page -`. +In the event that your Salt minion is having issues, a variety of solutions +and suggestions are available. Please refer to the following links for more information: +.. toctree:: + :maxdepth: 2 + + minion Running in the Foreground ========================= @@ -209,8 +215,12 @@ needs to be run with the ``python26`` executable. Common YAML Gotchas =================== -An extensive list of :doc:`YAML idiosyncrasies -` has been compiled. +An extensive list of YAML idiosyncrasies has been compiled: + +.. toctree:: + :maxdepth: 2 + + yaml_idiosyncrasies Live Python Debug Output ======================== diff --git a/doc/topics/tutorials/index.rst b/doc/topics/tutorials/index.rst index 41fc24126a..12bc349fb4 100644 --- a/doc/topics/tutorials/index.rst +++ b/doc/topics/tutorials/index.rst @@ -69,5 +69,3 @@ Using Salt at scale :maxdepth: 2 intro_scale - the_master - the_minion diff --git a/salt/modules/dockerio.py b/salt/modules/dockerio.py index b219d9dbcf..c87965e30d 100644 --- a/salt/modules/dockerio.py +++ b/salt/modules/dockerio.py @@ -606,11 +606,13 @@ def create_container(image, CPU shares (relative weight) cpuset CPUs in which to allow execution ('0-3' or '0,1') + CLI Example: .. code-block:: bash salt '*' docker.create_container o/ubuntu volumes="['/s','/m:/f']" + ''' status = base_status.copy() client = _get_client() diff --git a/salt/modules/pagerduty.py b/salt/modules/pagerduty.py index 3f5e11854f..c1130fdf29 100644 --- a/salt/modules/pagerduty.py +++ b/salt/modules/pagerduty.py @@ -67,9 +67,11 @@ def create_event(service_key=None, description=None, details=None, CLI Example: + .. code-block:: yaml + pagerduty.create_event
\ - profile=my-pagerduty-account -: + profile=my-pagerduty-account + The following parameters are required: service_key