Commit Graph

67 Commits

Author SHA1 Message Date
Erik Johnson
93ee5ee2b0
Fix all Sphinx warnings
Well, all but one, which we expect to see
2018-05-31 15:28:25 -05:00
rallytime
72d16c9fa9 Update "yaml" code-block references with "jinja" where needed
There are many `.. code-block: yaml` definitions that should really
be `.. code-block: jinja` definitions. This commit cleans up some
of those and removes warnings like these from the doc build:

```
WARNING: Could not lex literal_block as "yaml". Highlighting skipped.
```
2017-03-15 10:22:19 -06:00
rallytime
2f74dcf685 Various doc updates to fix warnings in doc build 2017-02-06 16:56:58 -07:00
rallytime
02bfe7912c Remove more ":doc:" references from doc/* files 2016-12-15 15:36:44 -07:00
Nicole Thomas
f9ffcb697a [2016.3] Merge forward from 2015.8 to 2016.3 (#32784)
* json encode arguments passed to an execution module function call

this fixes problems where you could pass a string to a module function,
which thanks to the yaml decoder which is used when parsing command line
arguments could change its type entirely. for example:

__salt__['test.echo')('{foo: bar}')

the test.echo function just returns the argument it's given. however,
because it's being called through a salt-call process like this:

salt-call --local test.echo {foo: bar}

salt thinks it's yaml and therefore yaml decodes it. the return value
from the test.echo call above is therefore a dict, not a string.

* Prevent crash if pygit2 package is requesting re-compilation of the e… (#32652)

* Prevent crash if pygit2 package is requesting re-compilation of the entire library on production systems (no *devel packages)

* Fix PEP8: move imports to the top of the file

* Move logger up

* Add log error message in case if exception is not an ImportError

* align OS grains from older SLES with current one (#32649)

* Fixing critical bug to remove only the specified Host instead of the entire Host cluster (#32640)

* yumpkg: Ignore epoch in version comparison for explict versions without an epoch (#32563)

* yumpkg: Ignore epoch in version comparison for explict versions without an epoch

Also properly handle comparisions for packages with multiple versions.

Resolves #32229

* Don't attempt downgrade for kernel and its subpackages

Multiple versions are supported since their paths do not conflict.

* Lower log level for pillar cache (#32655)

This shouldn't show up on salt-call runs

* Don't access deprecated Exception.message attribute. (#32556)

* Don't access deprecated Exception.message attribute.

To avoid a deprecation warning message in logs.
There is a new function salt.exceptions.get_error_message(e) instead.

* Fixed module docs test.

* Fix for issue 32523 (#32672)

* Fix routes for redhat < 6

* Handle a couple of arguments better (Azure) (#32683)

* backporting a fix from develop where the use of splay would result in seconds=0 in the schedule.list when there was no seconds specified in the origina schedule

* Handle when beacon not configured and we try to enable/disable them (#32692)

* Handle the situation when the beacon is not configured and we try to disable it

* a couple more missing returns in the enable & disable

* Check dependencies type before appling str operations (#32693)

* Update external auth documentation to list supported matcher. (#32733)

Thanks to #31598, all matchers are supported for eauth configuration.
But we still have no way to use compound matchers in eauth configuration.
Update the documentation to explicitly express this limitation.

* modules.win_dacl: consistent case of dacl constants (#32720)

* Document pillar cache options (#32643)

* Add note about Pillar data cache requirement for Pillar targeting method

* Add `saltutil.refresh_pillar` function to the scheduled Minion jobs

* Minor fixes in docs

* Add note about relations between `pillar_cache` option and Pillar Targeting
to Master config comments with small reformatting

* Document Pillar Cache Options for Salt Master

* Document Minions Targeting with Mine

* Remove `saltutil.refresh_pillar` scheduled persistent job

* Properly handle minion failback failure. (#32749)

* Properly handle minion failback failure.

Initiate minion restart if all masters down on __master_disconnect like
minion does on the initial master connect on start.

* Fixed unit test

* Improve documentation on pygit2 versions (#32779)

This adds an explanation of the python-cffi dep added in pygit2 0.21.0,
and recommends 0.20.3 for LTS distros. It also links to the salt-pack
issue which tracks the progress of adding pygit2 to our Debian and
Ubuntu repositories.

* Pylint fix
2016-04-25 15:26:09 -06:00
rallytime
7554d0f42d Merge branch '2015.5' into '2015.8'
Conflicts:
  - doc/ref/states/include.rst
  - doc/topics/cloud/reactor.rst
  - doc/topics/reactor/index.rst
  - doc/topics/releases/2015.5.10.rst
  - doc/topics/tutorials/states_pt5.rst
  - doc/topics/windows/windows-package-manager.rst
  - salt/config.py
  - salt/modules/state.py
  - salt/states/grains.py
  - tests/integration/modules/sysmod.py
  - tests/unit/states/grains_test.py
2016-03-24 15:48:00 -06:00
Erik Johnson
1b97e4a3df Improve state module docs, replace references to state.highstate/state.sls with state.apply
Resolves #32037.
2016-03-21 22:56:17 -05:00
Jacob Hammons
0689815d0e Fixes for doc build errors 2015-05-27 11:40:31 -06:00
Nitin Madhok
9dc1e0b3ae Fixing sphinx errors and warnings 2015-05-18 12:12:07 -04:00
Nitin Madhok
931ece7d20 Fixing some spninx errors and violations 2015-03-31 12:54:32 -04:00
Dennis Hall
5cf8e389d4 Change Adjective in Starting States Tutorial
The line which compares the previous two examples to the following YAML
example should use a demonstrative adjective like 'these'.
2015-02-11 10:44:46 +01:00
Colton Myers
9446633e9d Merge remote-tracking branch 'upstream/2015.2' into merge-forward-develop 2015-01-21 12:05:51 -07:00
Colton Myers
88fb2e0036 Merge remote-tracking branch 'upstream/2014.7' into merge-forward-2015.2
Conflicts:
	doc/topics/tutorials/starting_states.rst
	salt/modules/linux_lvm.py
2015-01-20 15:19:53 -07:00
Colton Myers
1fb6fc0ba1 Fix the explanation of the Default Data - YAML section of starting states 2015-01-20 15:03:54 -07:00
twellspring
b78dff7011 Update starting_states.rst 2015-01-19 20:19:23 -08:00
Colton Myers
fc16bd16c0 Merge branch '2014.7' into merge-forward
Conflicts:
	doc/faq.rst
	doc/ref/states/compiler_ordering.rst
	doc/topics/best_practices.rst
	doc/topics/development/conventions/formulas.rst
	salt/config.py
	salt/modules/state.py
	salt/states/mount.py
	salt/utils/event.py
	tests/unit/utils/process_test.py
2014-12-16 14:45:25 -07:00
Seth House
51fa87c446 Change all state examples to use short-dec format for consistency
Closes #12419.

The command used to search the docs for state examples is below. This
generates a file in Vim's quickfix format that can be loaded with the -q
flag.

find . -type f \( -name '*.rst' -o -name '*.py' \) -print0
    | xargs -0 -P10 -n1 awk '
        BEGIN { RS=""; FS="\n" }
        { linenr = linect; linect += (NF + 1) }
        /^\s+[a-zA-Z0-9'\''_-]+:\n\s+[a-zA-Z0-9'\''_-]+:\n\s+- / {
            print FILENAME "|" linenr + 2 "|", $1
        }
    ' > ./salt-states.quickfix
2014-12-12 23:36:40 -07:00
Thomas Jackson
c1860f3dd9 Comma cleanup 2014-12-12 11:32:58 -08:00
Thomas Jackson
c18e834be1 Fix trailing whitespace
Conflicts:
	doc/topics/tutorials/states_pt2.rst
2014-12-11 07:53:19 -08:00
Erik Johnson
57096ca59c Convert double-colon to code-block 2014-07-14 12:37:13 -05:00
Chris Rebert
8af229253f more copyediting 2014-04-30 13:55:48 -07:00
Evan Borgstrom
fb98e76fb0 Adding pyobjects documentation to the tutorial 2014-02-26 12:19:00 -05:00
Mike Place
a485eceac9 Fix all broken links in docs. Ignore certain known-good links. Adjust many links that are returning 301.
Conflicts:
	doc/topics/installation/index.rst
2014-02-20 16:16:59 -07:00
Erik Johnson
673815b718 Add note about top.sls to the "starting states" tutorial
Also cleaned up a bit of a redundancy, and removed a reference to a
section called "State Data Structures" which appears to no longer exist.
2013-10-03 20:30:35 -05:00
Erik Johnson
c86c855279 Better way of emphasizing S, L, and S in docs
Pull req #6972 negated a 100% intentional design decision, intended to
draw attention to the S, L, and S in "SaLt State file" to show why they
are called "SLS files". This commit reverts that change, and bolds the
S, L, and S so that this is more apparent.
2013-08-30 18:05:38 -05:00
Ajith Antony
f880d57af3 SaLT -> Salt 2013-08-30 15:41:15 -05:00
Erik Johnson
9c63495e04 Formatting fixes
This completes the documentation audit begun in cf365f7, using proper
backticks and :strong: tags to emphasize text, converting groups of
shell commands to bash code-block sections, etc. This also replaces the
use of \* with the easier-to-grok '*', which will hopefully reduce
confusion among new users.
2013-08-11 22:17:47 -05:00
Seth House
1ad733a2c0 Added missing 's' in cross-reference 2013-07-23 16:07:03 -06:00
Pedro Algarvio
a91b6ae02c Linked the dictionaries, strings, lists and numbers to the python documentation. 2013-07-23 21:42:33 +01:00
Erik Johnson
e28f8bcf65 Make templating notes flow better with renderer docs
Did not realize that renderers are mentioned a few paragraphs before the
section I added in 8c3cb95. This commit moves that data up to the
section describing the renderers.
2013-07-21 16:57:12 -05:00
Erik Johnson
8c3cb95d84 Add note RE: templating to "starting states" doc 2013-07-21 15:58:37 -05:00
Erik Johnson
323243332e Document the SLS file namespace 2013-06-20 19:51:19 -05:00
yinchuan
6c136b7a86 modify a sentence for more accurate 2013-05-30 18:17:39 +09:00
Thomas S Hatch
4de347fb39 Some more notes on service names 2013-04-30 13:15:01 -06:00
Thomas S Hatch
20ee5dcd1c Add note on package and service names 2013-04-29 17:26:49 -06:00
Tim Hollinger
96fa0c48f9 Changed to 3rd person
Changed to 3rd person
2013-04-05 14:52:51 -06:00
Tim Hollinger
98ca53c218 Fixed 80 column width
Due to fussy programmers that still live with 1972 standards :P
2013-04-05 14:20:36 -06:00
Tim Hollinger
164e3c796f Improved readability, grammar
Swapped 'a' for 'an' where necessary.  Changed verb agreement.
Uncluttered scentences.
2013-04-05 13:49:51 -06:00
Gary Wilson Jr
bd499e5640 Fixed several minor misspellings and acronym capitalizations. 2013-03-18 16:42:57 -05:00
Gary Wilson Jr
cc72ebb1fb Fixed :doc: uses in the docs that were not rendering due to an extra space. 2013-03-18 16:42:56 -05:00
Thomas S Hatch
8f4216b025 Add note about pillar walkthrough to starting states 2013-03-13 23:45:43 -06:00
Thomas S Hatch
430cd2788b Add redirect to pillar walkthrough at the end 2013-03-13 23:45:43 -06:00
Jack Kuan
28f2569879 Fix a typo and try to squeeze in pydsl along the py renderer to give it more publicity! ;) 2013-02-26 13:16:02 -05:00
Erik Johnson
b7251d8013 small spelling correction 2013-01-24 15:01:54 -06:00
Seth House
dc737520b9 Moved document fragments into excluded directory
This avoids "document isn't included in any toctree" warnings.
2013-01-24 00:06:02 -07:00
Jay Pipes
ef5e11168c Adds a note to starting_states tutorial explaining file.managed shortcut
address issue #2412

Just adds a note section to the starting_states tutorial doc
page that explains the file.managed shortcut to make it a bit
easier for beginner Salt users to understand...
2012-10-31 16:47:58 -04:00
Jay Pipes
0332c76147 Tiny YAML correction in starting_states tutorial doc page. 2012-10-31 16:11:54 -04:00
G. Clifford Williams
d399da4259 Merge branch 'master' of https://github.com/saltstack/salt into develop
Conflicts:
	doc/ref/renderers/all/index.rst
2012-10-20 11:54:50 -05:00
G. Clifford Williams
86abc2ae3a added wempy to tutoials/starting_states 2012-10-16 14:52:26 -05:00
Clint Savage
9a5d086bf3 more documentation cleanup 2012-08-03 00:23:39 -06:00