Commit Graph

378 Commits

Author SHA1 Message Date
Daniel Wallace
b767d340ee Add documentation on altering states. 2014-05-27 13:14:42 -05:00
Seth House
e150b9fc61 Added missing versionadded to onchanges requisite
Thanks to agronholm on IRC.
2014-05-21 18:46:35 -06:00
Ryan Lane
92f21c7b05 Adding boto_* modules and states to documentation. 2014-05-20 18:06:17 -04:00
Seth House
59f2d07ffb Bunch of misc rST fixes 2014-05-14 12:02:55 -06:00
KennethWilke
bd18389507 moar docs, moar betta 2014-05-13 15:07:30 -05:00
Thomas S Hatch
af58d29ab6 Add initial docs on onchanges and onfail 2014-05-07 16:02:36 -06:00
Thomas S Hatch
2bcad0c037 iAdd initial mod_aggregate docs 2014-05-05 16:23:09 -06:00
Thomas S Hatch
0606f4b78c initial docs for the mod_aggregate system 2014-05-05 16:00:17 -06:00
Chris Rebert
7d1df94bb1 copyedit ref docs 2014-04-30 14:08:31 -07:00
rallytime
12d5d87451 Some grammatical changes 2014-04-21 13:48:35 -06:00
rallytime
5789d4800c Clarifications for require, watch, and prereq in requisites documentation 2014-04-21 13:40:00 -06:00
Seth House
14515c3c8b Added generated templates for the new additions 2014-04-17 12:20:07 -06:00
Seth House
d2f057b0fd Combed through all the module types to add recent additions to the docs 2014-04-17 12:16:26 -06:00
rallytime
315247f208 Name consistency 2014-04-16 14:26:59 -06:00
rallytime
5354290157 Small yaml fix 2014-04-16 14:25:07 -06:00
rallytime
51bb1d31e6 Updated Requisites doc and added more explanation and examples to watch_in 2014-04-16 14:19:03 -06:00
Seth House
e222a9bd1c Add missing True return to state example when state is already correct 2014-04-15 15:51:43 -06:00
Pedro Algarvio
2b2754d683 Don't encourage bad **kwargs usage. 2014-04-13 14:38:04 +01:00
Seth House
640f613364 Added a full but simplistic example of writing a state module 2014-04-11 14:08:53 -06:00
Colton Myers
5b6b30e896 Add note about multiple extends of a single state 2014-04-03 15:19:34 -06:00
Erik Johnson
83063c8d68 Fix broken links and other sphinx errors 2014-03-17 17:17:18 -05:00
Mike Place
fc89a3e9c4 Rename state ordering section 2014-03-14 14:19:32 -06:00
Thomas S Hatch
58676463d8 Merge pull request #11218 from terminalmage/docs
New module busywork for htpasswd state/module
2014-03-13 21:06:06 -06:00
Erik Johnson
19663ee9bf Add htpasswd state to docs 2014-03-13 21:43:58 -05:00
Erik Johnson
fc062e5d27 Move OverState and state.sls docs to new location 2014-03-13 20:59:28 -05:00
Nicolas Delaby
2925e7618d add reference to htpasswd module in states index 2014-02-28 09:27:13 +01:00
Seth House
86e0075fcf Updated tutorials, highstate, and PyDSL docs from term links to ref 2014-02-27 19:43:12 -07:00
Seth House
46c1f24f8a Added ref anchor for highstate docs 2014-02-27 19:38:57 -07:00
Seth House
21d4092c77 Added ref anchor for overstate docs 2014-02-27 19:38:57 -07:00
Seth House
fdfda7869e Added ref anchors to state layers doc 2014-02-27 19:38:57 -07:00
Seth House
c29f9205ad Added ref anchors for the top file and environments 2014-02-27 19:38:57 -07:00
Seth House
276d05b464 Added ref anchors for the ordering sections 2014-02-27 19:38:57 -07:00
Seth House
bf9ae06cc6 Removed old, scattered glossary entries 2014-02-27 19:38:56 -07:00
Mike Place
2637fc689f Docs build cleanly! Yay! 2014-02-26 13:32:33 -07:00
Mike Place
6af7ff5dff First pass at refactoring Salt documentation. 2014-02-26 13:31:11 -07: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
Mike Place
362931561d States index re-write for clarity. 2014-02-19 15:36:14 -07:00
Ted Strzalkowski
e2949d865d Updated requisites docs to only monospace sls keys 2014-01-31 19:54:21 -08:00
Dan Garthwaite
1edaf7c345 states_run_on_minions_8389 2014-01-31 12:43:51 -05:00
Forrest Alvarez
db01d53d53 Updated requisite docs to try and clarify issues regarding the difference between requisite, and requisite_in. 2014-01-28 04:31:25 +00:00
Thomas S Hatch
4fd5512685 clean out extra whitespace 2014-01-27 10:30:45 -07:00
Alexey Ivanov
d23ff3821e
codespell: grammar nazi
Run codespell[1] against sources.

[1] https://github.com/lucasdemarchi/codespell
2014-01-26 18:41:28 -08:00
Mathieu Le Marec - Pasquet
7039b4c974 postgres: support for extensions 2014-01-21 19:25:35 +01:00
Thomas S Hatch
70f637d1a1 Clarify require document 2014-01-20 12:08:59 -07:00
Erik Johnson
f636d1d4ed Fix refs to yumpkg5 2014-01-17 21:08:44 -06:00
Erik Johnson
f38793166c Alias module.watch to module.wait
This was done recently for cmd.watch, so this commit aliases the
module.watch state as well for consistency.
2013-12-30 17:34:55 -06:00
Erik Johnson
ddad8760a5 Add new pagerduty module/state to docs 2013-12-25 08:45:26 -06:00
Erik Johnson
4f6d448af5 Add new XMPP module/state to docs 2013-12-24 17:58:09 -06:00
Erik Johnson
12c0df5123 Hide cmd.watch state alias from docs 2013-12-23 11:23:16 -06:00
Seth House
a0ef5f7964 Updated doc title to reflect actual module name
Refs #9366
2013-12-20 15:35:28 -07:00
Colton Myers
d61a93fde5 Document availability of templating variables, Fix #9261 2013-12-18 11:13:21 -07:00
Erik Johnson
1aeec6fbae Fix example in template variable reference docs 2013-12-14 14:22:30 -06:00
Erik Johnson
c88269351b Remove references to yumpkg in documentation 2013-12-13 18:01:34 -06:00
Seth House
e6ed5e2889 Added docs for new execution and state modules 2013-12-12 23:29:56 -07:00
Seth House
e252ee8f8a Updated docs for buildout -> zcbuildout rename 2013-12-12 23:29:56 -07:00
Forrest Alvarez
52e6d273f6 updated the faq to add a note about backup_mode, fixed a typo in the backup mode docs, and updated one of the file.managed examples with a backup line, as well as an additional note directing the user to the backup mode documentation in a highly visible area. 2013-12-08 05:52:45 +00:00
Thomas S Hatch
77d61d92a4 Merge pull request #8914 from makinacorpus/issue-8856-buildout-support
feat: buildout support
2013-12-03 09:56:59 -08:00
Joe Healy
45525b4b59 Doc fixes to remove errors and warnings 2013-12-01 18:29:16 +11:00
Mathieu Le Marec - Pasquet
228c987b76 feat: buildout support
This fixes #8856.
2013-11-29 18:51:20 +00:00
regilero
1e855fdef1 Document the fact use does not inherit requisites, @ref #8796 2013-11-27 09:41:34 +01:00
Joseph Hall
0765eeb983 Merge pull request #8728 from basepi/watchdocs
Add some additional docs for `cmd.wait` for the watch requisite
2013-11-21 14:02:58 -08:00
Henrik Holmboe
43ec66d049 Add state documentation for AWS SQS. 2013-11-21 22:34:53 +01:00
Colton Myers
ca72744cc7 Add some additional docs for cmd.wait for the watch requisite 2013-11-21 14:33:52 -07:00
hvnsweeting
dd38ba8fc6 remove confusing example about order option
clarify that state with order option should not be require/required by other
2013-11-20 19:44:11 +07:00
Sylvestre Ledru
0d5afed1a8 Debian is not necessary a Linux. It can also be a Freebsd or HURD based 2013-11-19 17:23:56 +01:00
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