Commit Graph

313 Commits

Author SHA1 Message Date
Sylvestre Ledru
03f14de476 Fix more typos in the documentation 2013-11-19 17:22:56 +01:00
Sylvestre Ledru
b9a04bcc68 Consistency change in the documentation 2013-11-19 17:03:28 +01:00
Sylvestre Ledru
49de8e0aa9 Fix some minor typos 2013-11-19 16:57:51 +01:00
Erik Johnson
0c488ede5d Add windows network state to docs 2013-10-25 12:47:45 -05:00
Thomas S Hatch
68b90aa00e Merge pull request #8097 from cmartyniuk/patch-1
Added information about sls type requisites
2013-10-25 09:20:40 -07:00
Thomas S Hatch
d6c970a9c8 Fix first person refs 2013-10-25 09:02:43 -06:00
cmartyniuk
6ef4b6bfcc Added information about sls type requisites 2013-10-25 09:18:38 -03:00
Elias Probst
e483404260 Corrected typos. 2013-10-22 19:38:31 +02:00
Erik Johnson
433f4a98da Add new ports state to docs 2013-10-16 23:50:12 -05:00
Seth House
b0754813df Added docker execution and state modules to docs 2013-10-16 10:58:04 -06:00
Seth House
fd7fd06ebc Removed docs for lxcdocker execution and state modules 2013-10-16 10:47:12 -06:00
Thomas S Hatch
7d164e687e Merge pull request #7864 from makinacorpus/docker
Docker support
2013-10-15 16:13:39 -07:00
Seth House
8500b88354 Added new/missing state modules 2013-10-15 16:00:02 -06:00
Seth House
0f3c0bc8bb Checked in generated docs for freebsdports module and ntp state module 2013-10-15 16:00:01 -06:00
Mathieu Le Marec - Pasquet
7dc46a2bbe Merge remote-tracking branch 's/develop' into docker 2013-10-14 00:52:33 +02:00
Erik Johnson
c57572d98d Fix documentation page for win_dns_client state
When I added this, it was copied from the one I created for win_system,
but it was not updated to be specific to win_dns_client, resulting in in
build warnings and incorrect documentation on docs.saltstack.com.
2013-10-12 15:26:12 -05:00
drawsmcgraw
5e765ad837 Added an example for the 'use' requisite. 2013-10-12 00:31:58 -04:00
Erik Johnson
253abc5fa1 Add new windows states to the docs 2013-10-09 20:34:21 -05:00
Mathieu Le Marec - Pasquet
168cb23134 Merge remote-tracking branch 's/develop' into docker 2013-10-09 19:19:11 +02:00
Thomas S Hatch
9268a344cc Add note on environment option in the minion config file 2013-10-07 23:25:03 -06:00
Mathieu Le Marec - Pasquet
dc1a8883ce Merge remote-tracking branch 's/develop' into docker_cur 2013-10-03 10:10:40 +02:00
Mike Place
af376a7706 The documentation for state ordering contained duplicate information about 0.17 in two contiguous paragraphs. Removed the first of those occurrences to improve readability. 2013-10-02 15:19:41 -06:00
Mathieu Le Marec - Pasquet
5bd4667a75 add docker 2013-10-02 21:28:03 +02:00
Henrik Holmboe
3b24019f22 solaris_group used for group provider on Solaris-based OSes 2013-10-01 13:53:05 +02:00
Daniel Smith
d2a3bde793 Fixes typo 2013-09-30 12:31:05 -07:00
Thomas Grainger
7e3bf3bc12 Fix grammar in Watch In state documentation 2013-09-30 16:33:05 +01:00
Thomas S Hatch
52238c62f9 Start on the master side state doc 2013-09-18 08:36:57 -06:00
Colton Myers
374525f1f5 Update wording for top file compilation to avoid confusion
Ref #7285

The previous wording could make it sound like the base *environment* was
authoritative, rather than just the top file.
2013-09-17 14:32:07 -06:00
Erik Johnson
0c29864863 docs update: add augeas state to toctree 2013-09-06 18:46:25 -05:00
Henrik Holmboe
553555ba6f Add apt.held state
Uses the new dpkg.get_selections and dpkg.set_selections.
2013-09-06 02:03:43 +02:00
Henrik Holmboe
46fb3bcf28 Syntax of versionadded 2013-09-03 14:59:14 +02:00
hvnsweeting
0091937b3d wrap match name in quote to make sure it work 2013-08-27 00:04:44 +07:00
Pedro Algarvio
c86d35e580 Add documentation about explicit module reload on states. 2013-08-23 12:50:36 +01:00
Pedro Algarvio
5075898935 No absolute imports. 2013-08-22 21:45:45 +01:00
Pedro Algarvio
8072edb7fd Fix module name to import. 2013-08-22 19:02:18 +01:00
Pedro Algarvio
df8bdf8646 By forcing absolute imports, we don't have to rename the pip state module. 2013-08-22 19:02:18 +01:00
Pedro Algarvio
55b11af356 Update documentation to the renamed pip state 2013-08-22 19:02:18 +01:00
Erik Johnson
38f1bc33cf Add lines for {net,open}bsdservice to State Providers doc
These lines were left incomplete in f15ce62, this commit finishes them.
2013-08-21 20:39:24 -06:00
Erik Johnson
f15ce62cea Add more information on overriding providers
As noted in IRC, if you are using a custom linux spin or derivative, it
may not be apparent which provider to use when overriding providers in
the minion config file. This commit adds a massive table for the pkg,
service, user, and group providers which explains how they are used, to
help guide the user to the correct decision when specifying a provider
override.
2013-08-21 16:49:25 -06:00
Pedro Algarvio
0f837d2702 Merge pull request #6811 from s0undt3ch/hotfix/absolute-imports
Because of the recent salt sys module rename, force absolute imports.
2013-08-20 16:11:41 -07:00
Pedro Algarvio
1956a6e5cc Sort modules and states. 2013-08-21 00:10:26 +01:00
Pedro Algarvio
bd002f97da Revert "By enforcing absolute imports, there's no need for module name aliases."
This reverts commit a1a2b49a72.
2013-08-20 23:44:05 +01:00
Pedro Algarvio
0b9851e2bb Revert "Since the module/state got renamed, let's leave a link pointing to the new names."
This reverts commit e724e54199.
2013-08-20 23:43:59 +01:00
Pedro Algarvio
e894db7ffa Revert "Renamed debconfmod module and state to debconf while enforcing absolute imports."
This reverts commit 04e3874b42.
2013-08-20 23:43:57 +01:00
Pedro Algarvio
39b87cecfb Revert "Fixed documentation linking."
This reverts commit 758e789d12.
2013-08-20 23:43:48 +01:00
Chris Rebert
d854574bf9 copyedit state ordering docs 2013-08-20 12:21:26 -07:00
Thomas S Hatch
e263e9a7b9 Add state_auto_order docs 2013-08-20 11:55:24 -06:00
Pedro Algarvio
758e789d12 Fixed documentation linking. 2013-08-19 17:40:07 +01:00
Pedro Algarvio
04e3874b42 Renamed debconfmod module and state to debconf while enforcing absolute imports. 2013-08-19 14:17:00 +01:00
Pedro Algarvio
e724e54199 Since the module/state got renamed, let's leave a link pointing to the new names. 2013-08-19 13:53:19 +01:00
Pedro Algarvio
a1a2b49a72 By enforcing absolute imports, there's no need for module name aliases. 2013-08-19 13:23:46 +01:00
Erik Johnson
16b184bb5f Add rst pages for new modjk state/module
This commit tells sphinx to build doc pages for these new files, and
adds them to the table of contents.
2013-08-13 11:02:44 -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
Colton Myers
7743c77d9d Add the salt.states.iptables docs 2013-08-05 18:10:41 -06:00
Colton Myers
34d156bd6d Add iptables to state index 2013-08-05 18:08:15 -06:00
Erik Johnson
06a61bc5e6 Fix more broken links
Two links in doc/ref/states/highstate.rst were broken, resulting in
warnings when running sphinx-build to build the html docs. They were
trying to link within the same page, and the section did not exist,
these sections were probably split off into a separate page
(doc/ref/states/requisites.rst) some time ago and these were never
updated to reflect that.
2013-08-03 19:27:17 -05:00
Erik Johnson
fa6170d9f4 Add explanation of the kwargs passed to states 2013-08-01 19:48:23 -05:00
David Boucha
c552c6b537 Add doc on requiring an entire sls file 2013-08-01 11:03:21 -06:00
Erik Johnson
3a2fbbf7dc add information to backup restoration docs 2013-07-27 18:20:06 -05:00
Erik Johnson
a77a7bd5f1 Document backup listing/restoring/deleting 2013-07-27 18:09:41 -05:00
Erik Johnson
1a9f069bf0 Document how top files are compiled from different envs 2013-07-25 17:11:33 -05:00
Erik Johnson
38b2e3c991 Add example of watch requisite 2013-07-20 23:25:22 -05:00
Pedro Algarvio
03f09eb99c Updated documentation since virtualenv module and state module were renamed to virtualenv_mod. 2013-07-20 18:59:49 +01:00
Erik Johnson
7693cd3f6e Fix typo in top.sls docs
The extra ':' here negates the code-block section. Removed it.
2013-07-13 22:30:18 -05:00
Erik Johnson
1b876fc53a Clarify docs on custom types 2013-07-08 21:36:34 -05:00
Joost Cassee
26edf918fb Add documentation for shorthand syntax 2013-07-04 00:31:07 +02:00
Seth House
3412729a84 Added bsd_shadow and portage_config execution/state module docs 2013-07-03 15:43:42 -06:00
Kevin Tran
7122651d20 Fixed spelling 2013-06-22 14:24:14 -07:00
Colton Myers
bad8ed6d28 Document that top files are combined from various environments
Ref #5440
2013-06-19 10:08:05 -06:00
Chris Rebert
6a5ff56426 copyediting and formatting 2013-06-18 15:01:57 -07:00
Thomas S Hatch
320652e211 Add docs on prereq and prereq_in 2013-06-18 01:52:10 -06:00
Chris Rebert
d5b7c7d037 requisites.rst: minor copyediting 2013-06-17 13:02:27 -06:00
Thomas S Hatch
89d6d1241c Add initial prereq docs, this needs a lot more, and a tutorial 2013-06-15 00:44:54 -06:00
Chris Rebert
7e79440c8d copyedit states/layers.rst 2013-06-10 17:11:29 -07:00
Thomas S Hatch
f76fb045c2 Add initial state layer documentation 2013-06-09 16:28:27 -04:00
Seth House
cfd349afe1 Fixed rST indentation on seealso 2013-06-07 12:47:47 -06:00
Seth House
4499cfed0b Added new state module docs 2013-06-06 17:05:50 -06:00
Thomas S Hatch
4f1339305f Add docs on overstate funciton calls 2013-05-28 04:45:47 +00:00
Thomas S Hatch
31c6045b01 Add vars reference document. Fix #5220 2013-05-27 18:48:21 +00:00
Thomas S Hatch
856eeb7746 Add docs for #5035 2013-05-16 17:51:50 -06:00
Thomas S Hatch
63058e3bde Merge pull request #4715 from shadowfax-chc/lvm
Lvm State
2013-05-01 22:18:28 -07:00
Seth House
45fcf66ee1 Added docs files for new modules 2013-04-30 14:16:22 -06:00
Seth House
32f063cb39 Added docs for new execution & state modules 2013-04-30 14:06:16 -06:00
shadowfax-chc
e0d8d2073f Added docs for lvm state 2013-04-29 21:37:18 -04:00
shadowfax-chc
8b7fb8cbd3 Added docs for lvm state 2013-04-29 21:36:55 -04:00
Thomas S Hatch
2affd3ee2a Add extra include docs, fix #4274 2013-04-28 20:19:43 -06:00
shadowfax-chc
28a93d5fee Added docs for mdadm state 2013-04-08 22:24:46 -04:00
Erik Johnson
a099d8df57 Update renderer docs
Remove reference to the python renderer being added in the future, as it
has been around for some time.
2013-04-07 00:51:19 -05:00
Seth House
ffb9bc557f Added disk, npm state module docs 2013-03-29 12:25:37 -06:00
David Boucha
fd90f534eb Merge pull request #4304 from JustinCarmony/docs-watch-in-plug
Adding a reference to watch_in on the highstate reference
2013-03-27 20:49:25 -07:00
Justin Carmony
1a333692ac Adding a reference to watch_in on the highstate reference 2013-03-27 21:44:57 -06:00
Jeff Schroeder
86e7900c29 Adding tomcat state documentation
Fixes #4256
2013-03-26 00:06:12 -05:00
Thomas S Hatch
1f0d9d7dab Add libvirt docs to the doc index 2013-03-21 15:22:46 -06:00
Thomas S Hatch
8c3212faba Add libvirt to the index 2013-03-21 15:22:32 -06:00
Gary Wilson Jr
bd499e5640 Fixed several minor misspellings and acronym capitalizations. 2013-03-18 16:42:57 -05:00
ydavid365
bc756c69be added grains state module to docs 2013-02-18 00:11:51 -08:00
Erik Johnson
5eef8217d6 Add notes on requisite matching 2013-02-13 21:34:21 -06:00
Erik Johnson
d14d859154 Minor tweaks to doc headings
Corrected odd grammar on the Modules doc page, and changed a similar
heading in the States docs to match the same wording.
2013-02-10 22:20:56 -06:00
Erik Johnson
d4b120a003 Replace hard-coded links w/relative ":mod:" links 2013-02-03 14:54:04 -06:00
David Boucha
a54bfb07e6 Fix typo 2013-01-22 08:02:39 -07:00
shadowfax-chc
0e2bd0bee0 Added state for managing postgres groups 2013-01-16 18:17:12 -05:00
Godefroid Chapelle
8613232b29 Update doc/ref/states/highstate.rst
Avoid any ambiguity about dots in IDs.
2013-01-13 15:02:19 +01:00
Seth House
0d1cc6e272 Added docs files for new module types 2013-01-11 14:48:30 -07:00
Seth House
91ea50b916 Added missing new modules of varying types 2013-01-11 14:37:01 -07:00
shadowfax-chc
8e315e2103 Added docs for layman state 2013-01-03 20:27:35 -05:00
Godefroid Chapelle
6c74931ea8 Update doc/ref/states/highstate.rst
fix Rest formatting mistakes
2012-12-27 20:12:18 +01:00
Thomas S Hatch
ba42755935 Add explanation of "issue" to overstate doc 2012-12-27 09:55:15 -07:00
Godefroid Chapelle
ef00765f30 Update doc/ref/states/highstate.rst
More details in large example
2012-12-27 10:47:23 +01:00
Erik Johnson
92ab669a1f Provider doc enhancements
1) Added an example for the minion config option "providers".

2) Cleaned up line widths on solaris install instructions, and added
   information on how to use pkgutil as the default package provider.

3) Since systemd is the default provider for Arch Linux now, I corrected
   the information in the "State Providers" page so that the example of
   overriding the service provider reflects the current state of the
   codebase.
2012-12-21 21:40:01 -06:00
Thomas S Hatch
169c5314c4 Merge pull request #2968 from nkuttler/doc_fixes
Fix three small typos
2012-12-20 08:33:59 -08:00
Nicolas Kuttler
657878dcdc Add missing colons 2012-12-20 16:51:30 +01:00
Erik Johnson
5def1dd54c Updated docs for grains, modules, and states
Added links to module function documentation, as well as to
"file_roots", and mentioned the saltutil.sync_* functions. Will probably
do the same for returners and renderers soon. This should help people
navigate through the docs easier.
2012-12-18 23:29:36 -06:00
Erik Johnson
15cd4278a4 change reference to 0.10.6 to 0.11.0 2012-12-16 01:25:05 -06:00
Jack Kuan
06484a2d8b Some random doc updates. 2012-11-24 02:07:53 -05:00
Thomas S Hatch
f9f0200eca Add docs on executing the overstate 2012-11-19 23:28:57 -07:00
Thomas S Hatch
12fce1d79c Add overstate docs 2012-11-19 22:51:19 -07:00
Seth House
659ca23a92 Added docs for new state modules 2012-11-14 12:51:54 -07:00
Seth House
747c6ff6a8 Normalized the "all" modules pages to use the qualified module term 2012-10-29 18:23:56 -06:00
Seth House
c4ff039147 Added a note about the providers minion conf; misc fixes 2012-10-11 14:44:23 -06:00
Seth House
1c0a0e5965 Removed incorrect colon from function dec in highstate structure 2012-10-11 11:41:15 -06:00
Seth House
1efeae5e6c Misc rST fixes and minor text fixes 2012-10-11 00:11:06 -06:00
Seth House
2e0cfc1feb Added a glossary entry for environments 2012-10-11 00:11:06 -06:00
Seth House
c5302ae0d6 Added new/missing modules/states to docs TOC & generated files 2012-10-04 18:52:50 -06:00
Thomas S Hatch
857cff66af Fix #458 2012-09-27 15:40:17 -06:00
Thomas S Hatch
ec1df1769d Add exclude docs 2012-09-22 15:55:32 -06:00
Thomas S Hatch
528600692b Add docs for the new startup_states option 2012-09-20 12:22:12 -06:00
Thomas S Hatch
d76f051610 dd some more docs making the order to requitie relationship
a little more clear
2012-09-20 09:39:16 -06:00
Thomas S Hatch
2e89eb0049 Add docs for the test: True config option 2012-09-12 13:18:15 -06:00
Clint Savage
a79caf940d fixed 'recurse' typo in several locations 2012-08-27 21:26:41 -06:00
Thomas S Hatch
3fb8e20d97 initial docs on testing interface 2012-08-27 10:44:00 -06:00
Seth House
01c654d8f1 Added missing modules/states/renderers docs to reference TOC 2012-07-30 00:53:21 -07:00
Thomas S Hatch
eeef52f52c Add backup_mode doc 2012-07-27 00:05:01 -06:00
Thomas S Hatch
53285798e0 The watcher function is called mod_watch now
and has been for some time...
2012-07-15 01:03:26 -06:00
Intchanter
588f93a5cd Made some language clearer. 2012-07-15 00:57:53 -06:00
Seth House
36effed649 Revert "Merge branch 'doc-autosummary-headings' into develop"
This reverts commit 7997ed4842, reversing
changes made to 83c901a174.
2012-07-09 16:03:40 -07:00
Alec Koumjian
a22773bdde Instruct authors of state modules to check for the test parameter 2012-07-03 14:17:52 -07:00
Thomas S Hatch
e2e74d0b88 some more spelling errors 2012-06-18 15:12:10 -06:00
Thomas S Hatch
ae8a1cae27 horrid spelling errors. 2012-06-18 15:10:29 -06:00
Seth House
753ed3a500 Updated modules/states/renderers/returners with new autosummary layout 2012-06-18 00:45:15 -07:00
Seth House
fca05d214e Updated autosummary template to output headings for the Contents sidebar 2012-06-18 00:42:19 -07:00
Seth House
13acaab80a Revert "Revert "Merge pull request #1449 from elfixit/develop""
This reverts commit 6440faa4d0 but
restores the salt/states/service.py from last correct version.
2012-06-18 00:31:14 -07:00
Seth House
6440faa4d0 Revert "Merge pull request #1449 from elfixit/develop"
This reverts commit 31b093dd93, reversing
changes made to edf676a23e.

There was a mistake added that changed the salt/states/service.py file
to a binary type.

Conflicts:

	doc/ref/states/highstate.rst
	doc/ref/states/index.rst
	doc/ref/states/ordering.rst
2012-06-18 00:26:36 -07:00
Thomas S Hatch
3b31eb5423 Better explanation of what a function declaration is 2012-06-18 00:22:06 -06:00
Thomas S Hatch
51a8789bd2 Repair docs that violate the "double short dec" problem
This problem exists because these statements are not valid yaml. An
example is in the troubleshooting guide.
2012-06-18 00:09:38 -06:00
elfixit
3574518dec updated state docs to new style state syntax
updated the state docs to the new state syntax from:
http://salt.readthedocs.org/en/latest/topics/releases/0.9.9.html#state-syntax-update
2012-06-17 15:40:21 +02:00
Erik Johnson
0d08e4a137 Clarify match types in top.sls documentation
Examples of pillar, grain, grain_pcre, list, etc. are added.
2012-06-12 17:21:59 -05:00
Baiju Muthukadan
ada24af53c Few reStructuredText fixes/cleanups 2012-05-30 16:02:24 +05:30
Thomas S Hatch
2515033c08 Add docs on extend
Make sure people understand that using the extend keyword twice in a
single sls will cause unexpected results
2012-05-28 16:19:00 -06:00
Thomas S Hatch
1fa592bf0e Add ssh_known_hosts to docs 2012-05-26 09:28:17 -06:00
Thomas S Hatch
473be16991 Add selinux state to docs 2012-05-26 09:26:13 -06:00