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
32,889 Commits 24 Branches 182 Tags 341 MiB
c721d9d664
Commit Graph

1004 Commits

Author SHA1 Message Date
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
Seth House
cd1df50d25 Added `python` Jinja filter to jinja renderer docs 2014-01-23 19:41:16 -07:00
Thomas S Hatch
6b09f5b8fd Merge pull request #9831 from makinacorpus/pgsql 
[need review] PGSQL state/mod improvments
 2014-01-23 09:07:59 -08:00
Erik Johnson
e13b253f67 Add --roster-file online docs option (new in 2014.1.0) 2014-01-22 11:24:29 -06:00
Erik Johnson
40cd458d70 Correct salt-ssh docs inaccuracy 2014-01-22 11:18:09 -06: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
Thomas S Hatch
6c144e003e Log to trace instead of print, @pwaller per #9752 2014-01-16 10:49:41 -07:00
Peter Waller
054fccd3b7 Update index.rst 
Fix a pet peeve of mine so that beginners don't repeat the mistake: silencing `ImportError` is evil since you don't know if it came because `dependency_that_sometimes_exists` is unavailable or the `dependency_that_sometimes_exists` tried to import something which was broken.

This can seriously hinder debugging.
 2014-01-15 14:04:03 +00:00
Forrest Alvarez
563f99538d Fixed some errors that were getting generated. 2014-01-12 05:33:04 +00:00
Forrest Alvarez
13a7acff03 Updated the master configuration docs to fill out the rest of the items that were missing from the docs, also moved some stuff around so it was in the same order as the actual master conf file. 2014-01-12 05:23:09 +00:00
Forrest Alvarez
afab1e2d63 Updated the master config file with some options, made it down to the color option. Looking at how this is set up, things might need to be moved around. 2014-01-10 05:54:07 +00:00
Colton Myers
b43b0d5d09 Add more state vs module clarification 2014-01-07 16:55:28 -07:00
Thomas S Hatch
87b25ed67a Merge pull request #9601 from terminalmage/docs 
Replace references to Hydrogen release in docs
 2014-01-07 10:26:31 -08:00
Erik Johnson
6ab77e5317 Replace references to Hydrogen release in docs 
This replaces references to Hydrogen (in versionadded/versionchanged
directives as well as a few other mentions), to reflect the actual
release number of 2014.1.0.
 2014-01-07 12:06:53 -06:00
Thomas S Hatch
3f16b1b023 Merge pull request #9603 from techhat/jcl 
Clarify that execution modules and state modules are not the same thing
 2014-01-06 21:23:55 -08:00
Joseph Hall
214843c53b Clarify that execution modules and state modules are not the same thing 2014-01-06 19:57:01 -07:00
Erik Johnson
5a8faf4810 Add gitfs configuration parameters to master config docs 
This commit adds the new gitfs_provider parameter, as well as several
other params for gitfs that were not documented.
 2014-01-03 21:06:03 -06:00
Erik Johnson
1c442f7c4e Add some links to the fileserver backends docs 
This commit turns some of the config file parameters into links to the
master config file docs, and also links to the pages for the fileserver
backends being described.
 2014-01-02 10:33:50 -06:00
Erik Johnson
4cb0faba5e Fix sphinx warning due to mismatched header lines 2014-01-01 16:34:54 -06:00
Thomas S Hatch
aacaf6c24c Merge pull request #9503 from pakdel/minionfs 
MinionFS fileserver backend
 2013-12-30 21:02:03 -08:00
Amir Pakdel
ea3c23aa05 MinionFS fileserver backend 
The backend for serving files pushed to master
by cp.push (file_recv).
 2013-12-30 19:02:42 -05: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
Thomas S Hatch
b3b6c0bcee Merge pull request #8734 from terminalmage/autoreject_file 
add an autoreject_file parameter to the master config file
 2013-12-30 09:24:03 -08: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
a2271cb34c Remove docs references to nzbget 
This module was recently removed to salt-contrib.
 2013-12-23 13:38:08 -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
Thomas S Hatch
f2a8587940 Merge pull request #9377 from terminalmage/issue9363 
Full rewrite of memcached state and execution module
 2013-12-20 11:44:36 -08:00
Erik Johnson
180699ee7d Hide alias functions from docs 2013-12-20 13:40:06 -06:00
Seth House
6f22ac72a1 Fleshed out docs for each method in the various *Client() interfaces 2013-12-19 22:57:56 -07:00
Seth House
79ad988fef Fleshed out the Python API docs 2013-12-19 21:40:43 -07:00
Seth House
f051ad477c Added CloudClient to the Python API docs 2013-12-19 21:40:34 -07:00
Colton Myers
d61a93fde5 Document availability of templating variables, Fix #9261 2013-12-18 11:13:21 -07:00
Corey Quinn
58ac57c6af Fixed ping to test as per Tom yelling at me in Salt Class 2013-12-17 14:07:37 -08:00
Erik Johnson
1aeec6fbae Fix example in template variable reference docs 2013-12-14 14:22:30 -06:00
Seth House
91e254d2a6 Merge pull request #9260 from gravyboat/develop 
Updated clientacl docs to resolve 6802.
 2013-12-13 21:56:45 -08:00
Seth House
5ccc3c0b59 rST fix 2013-12-13 22:52:02 -07:00
Forrest Alvarez
ad9a2ed62f Updated clientacl docs to resolve 6802. 2013-12-14 05:45:31 +00:00
Seth House
d158fbefd4 Changed conf-log to conf_log to match the other conf_* roles 
@s0undt3ch Hope you don't mind.
 2013-12-13 17:34:59 -07:00
Erik Johnson
c88269351b Remove references to yumpkg in documentation 2013-12-13 18:01:34 -06:00
Thomas S Hatch
167c110f43 Add doc for yaml_utf8 2013-12-13 14:40:47 -07: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
Erik Johnson
3a6274fb3b Remove reference to yumpkg5 in provider override example 
yumpkg5 is the default now, so it shouldn't be included in an example of
overriding the provider.
 2013-12-09 14:16:19 -06: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
Erik Johnson
1c24bbe7fc Update salt-key documentation 
Bring docs.saltstack.com in line with the CLI usage
 2013-11-28 12:05:37 -06:00
regilero
1e855fdef1 Document the fact use does not inherit requisites, @ref #8796 2013-11-27 09:41:34 +01:00
Henrik Holmboe
c1bb9d5619 Upcase SSH in Salt SSH. 2013-11-24 00:18:40 +01:00
Erik Johnson
e7e84ff305 Add autoreject_file to master config file documentation 
Included a versionadded directive to note when this was added, to reduce
confusion.
 2013-11-21 17:12:31 -06: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
Jeffrey C. Ollie
b1fb52a680 fix more funcion => function typos 2013-11-15 14:50:17 -06:00
Seth House
076d99d214 Added a few cross-references from the Syndic docs to the master config 2013-11-11 17:51:25 -07:00
Seth House
d56e72143a Added explicit mention that Syndics maintain their own file_roots 2013-11-11 17:48:12 -07:00
Seth House
ee0dd1a669 Added autodoc generated cloud module docs 2013-11-11 16:25:28 -07:00
Seth House
8807eea450 Added directory for clouds modules documentation 2013-11-11 16:25:28 -07:00
Seth House
865b009e1e Merge pull request #8379 from sijis/misc_doc_fixes_2 
removed double colons in master documentation to match existing formatti...
 2013-11-09 17:08:13 -08:00
Erik Johnson
2b397ec24c Docs formatting fixes 
Format filenames in bullet points and use aliases instead of letting the
"blob" role show the full URL for the filenames.
 2013-11-09 15:10:12 -06:00
Sijis Aviles
1f27476fdd removed double colons in master documentation to match existing formatting 2013-11-09 13:54:39 -06:00
Seth House
e4f638e6d7 Moved salt-cloud documentation into main docs dir 2013-11-08 14:08:36 -07:00
Colton Myers
d5221c8fd6 Add doc for syndic_wait config option 2013-11-07 15:41:04 -07:00
Thomas S Hatch
c0f6fd68a3 Merge pull request #8303 from basepi/rmcluster 
Remove confusing "computer clusters" reference from docs
 2013-11-06 15:11:17 -08:00
Colton Myers
79fe2637bf Remove confusing "computer clusters" reference from docs 2013-11-06 12:11:08 -07:00
Colton Myers
f50ebad1f5 Add publish example for limiting targets 2013-11-06 11:03:31 -07:00
Forrest Alvarez
a1b4848dbc Updated minion.rst with a note on verify env for issue 8281. 2013-11-06 05:41:56 +00:00
Sergey
2da8e454e7 fix grammar in salt.renderers.jinja.rst 2013-11-05 18:28:21 +02: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
Wari Wahab
d2094f8b60 Fixed all typos I can find 2013-10-25 16:26:57 +08:00
Elias Probst
e483404260 Corrected typos. 2013-10-22 19:38:31 +02:00
Erik Johnson
c9b455c9fb add "chocolatey" module to docs 2013-10-18 13:09:54 -05:00
Erik Johnson
433f4a98da Add new ports state to docs 2013-10-16 23:50:12 -05:00
Thomas S Hatch
848bd5fc5e Merge pull request #7885 from loz-hurst/develop 
Added note about methods with trailing underscores to module docs.
 2013-10-16 10:12:16 -07:00
loz-hurst
91d7b2a346 Added note about methods with trailing underscores to module docs. 
Not fantastically impressed with what I've written and welcome for someone else to have a stab at it - trying to rectify that it's not clear from the docs ANYWHERE that, e.g., salt.states.alternatives.set_ must be specified as 'alternatives.set' or 'alternatives: - set' in the sls.  'alternatives.set_' or 'alternatives: - set_' will not work.

As a python coder it's obvious what's going on to avoid the name clash in the source but I wouldn't expect all salt users to be python programmers so it needs mentioning somewhere, imho.
 2013-10-16 18:10:02 +01: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
069b84fd24 Removed 'sys' from pseudo modules list; is real module now 2013-10-15 16:00:02 -06:00
Seth House
8500b88354 Added new/missing state modules 2013-10-15 16:00:02 -06:00
Seth House
f1f47b085f Added new/missing runner modules 2013-10-15 16:00:02 -06:00
Seth House
a577be0170 Added new/missing returner modules 2013-10-15 16:00:02 -06:00
Seth House
a719fec161 Added new/missing pillar modules 2013-10-15 16:00:02 -06:00
Seth House
1183924bcb Added new/missing auth modules 2013-10-15 16:00:01 -06:00
Seth House
7246864f1b Added new/missing execution modules 2013-10-15 16:00:01 -06:00
Seth House
0f3c0bc8bb Checked in generated docs for freebsdports module and ntp state module 2013-10-15 16:00:01 -06:00
Erik Johnson
277fb1e12e Add freebsdports module to docs 2013-10-15 13:02:27 -05: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
3ddb416a53 Remove inapplicable exclude-members directive 2013-10-09 21:31:05 -05:00
Erik Johnson
2cb6b1c8a3 Suppress function aliases from appearing in docs 2013-10-09 21:29:05 -05:00
Erik Johnson
46520512a6 Add win_ntp module to docs 2013-10-09 21:00:37 -05: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
Thomas S Hatch
a280c4dfa1 Merge pull request #7621 from cachedout/develop 
Documentation changes/updates
 2013-10-04 12:09:00 -07:00
Erik Johnson
f6e521a9e3 Add fileserver_backend to master configuration page 2013-10-04 11:04:14 -05:00
Mike Place
bd1da286ac -- Please review for accuracy prior to merge -- 
While I'm still learning the external pillar system, I suspect that this documentation was written when a smaller number of external pillars were available. I have removed the plain-text reference and instead linked directly to the repository directory which holds all pillars. If my assumption/understanding is incorrect, please feel free to reject. :]
 2013-10-03 15:41:37 -06:00
Mike Place
0593c3311d A minor clarity fix for documentation regarding the extension of Salt. 
I attempted to preserve what I believe to be the original intent of the author but please feel free not to merge these changes if you feel that I've failed in doing so. :]
 2013-10-03 14:51:49 -06:00
Mathieu Le Marec - Pasquet
dc1a8883ce Merge remote-tracking branch 's/develop' into docker_cur 2013-10-03 10:10:40 +02:00
Thomas S Hatch
323db1d44c Merge pull request #7560 from s0undt3ch/develop 
Update include documentation examples to current default values.
 2013-10-02 14:51:40 -07: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
Pedro Algarvio
0b0e82baaa Update include documentation examples to current default values. 2013-10-02 13:36:47 +01: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
Forrest Alvarez
1c043c3d45 Updated the salt-ssh.rst to add the new options that are available via the command line. Modified the ssh index.rst to include a link to the salt-ssh cli commands page. Updated parsers.py to fix the default value that is present in the documentation from 5 to 25 (as 25 is the actual default). Updated roster.rst to note that the default file location is /etc/salt/roster since it was absent, and might be confusing if you head to the roster documentation before reading the rest of the salt-ssh documentation. 2013-09-29 05:16:13 +00:00
Erik Johnson
905a8bd62a Update list of pkg providers in docs 2013-09-28 20:03:54 -05:00
Erik Johnson
ac5b5178bf Mask module aliases for freebsdpkg, pkgng modules 2013-09-21 12:01:47 -05:00
Erik Johnson
3b3255ddc4 Add new mac user/group modules to toctree 2013-09-21 12:01:47 -05:00
micahhausler
02122c3fa5 Added ext_pillar Django model field access through the ORM 
This external pillar will load django model fields into pillar
data.
 2013-09-20 13:03:02 -04:00
Joe Healy
b8924681b1 fixed a typo accidently introduced 2013-09-20 22:07:32 +10:00
Joe Healy
aece0976a6 Fixed pedantic spelling errors picked up by lintian 
joe@unstable-builder:~/salt_017rc/salt$ lintian -I ../*.deb
I: salt-common: spelling-error-in-manpage usr/share/man/man7/salt.7.gz softwares software - done
I: salt-common: spelling-error-in-manpage usr/share/man/man7/salt.7.gz specifed specified - done
I: salt-common: spelling-error-in-manpage usr/share/man/man7/salt.7.gz Targetting Targeting - done
I: salt-common: spelling-error-in-manpage usr/share/man/man7/salt.7.gz targetted targeted - done
I: salt-common: spelling-error-in-manpage usr/share/man/man7/salt.7.gz Dependant Dependent - done
I: salt-common: FSSTND-dir-in-manual-page usr/share/man/man7/salt.7.gz:57301 /var/named/ - not done - example
I: salt-common: FSSTND-dir-in-manual-page usr/share/man/man7/salt.7.gz:57320 /var/named/ - not done - example
I: salt-common: FSSTND-dir-in-manual-page usr/share/man/man7/salt.7.gz:57339 /var/named/ - not done - example
I: salt-common: spelling-error-in-manpage usr/share/man/man7/salt.7.gz recieve receive - done
I: salt-common: spelling-error-in-manpage usr/share/man/man7/salt.7.gz allows to allows one to - done
I: salt-common: spelling-error-in-manpage usr/share/man/man7/salt.7.gz allows to allows one to - done
I: salt-common: spelling-error-in-manpage usr/share/man/man7/salt.7.gz dont don't - done
I: salt-common: spelling-error-in-manpage usr/share/man/man7/salt.7.gz succesfully successfully - done
I: salt-common: spelling-error-in-manpage usr/share/man/man7/salt.7.gz softwares software - done
I: salt-common: spelling-error-in-manpage usr/share/man/man7/salt.7.gz These package This package - not done - legitimate
 2013-09-20 22:01:20 +10:00
Justin Carmony
7e2389782c Adding versionadd's for salt cli ref and salt.states.file to denote some new 0.17 features 2013-09-19 11:22:03 -06:00
Colton Myers
1626768ef7 Merge pull request #7314 from s0undt3ch/develop 
Fix code blocks and updated the Sentry threaded transports information.
 2013-09-18 09:59:46 -07:00
Thomas S Hatch
52238c62f9 Start on the master side state doc 2013-09-18 08:36:57 -06:00
Pedro Algarvio
48990a4bc2 Don't show the module members, these can be considered internal. 2013-09-18 11:42:50 +01: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
Mickey Malone
8e8ea379e9 Added the sqlite3 returner to the docs. Fixed spelling mistakes. 2013-09-11 22:39:54 -05: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
David Boucha
b386267e70 Merge pull request #7073 from equinoxefr/patch-2 
Update windows-package-manager.rst
 2013-09-05 12:01:46 -07:00
Erik Johnson
dd30dfeac4 Fix sphinx build warning and move FAQ to root 
This fixes a warning from new pages not being in a toctree, as well as
moves the new FAQ page from the /ref dir to the root.
 2013-09-05 13:46:32 -05:00
Erik Johnson
e275ca9921 Fix sphinx build warnings (new modules not in toctree) 2013-09-05 13:43:46 -05:00
Pierre DOUCET
deb554cd72 Update windows-package-manager.rst 2013-09-05 20:41:26 +02:00
Erik Johnson
c7f655a544 Update the FAQ 
This commit adds new information to the FAQ, as well as switching from
in-depth documentation for a couple topics to linking to this
documtnation on the relevant pages elsewhere in the docs.
 2013-09-05 13:40:10 -05:00
Erik Johnson
d05ca4fd63 Fix sphinx build error 
The '=' for the header did not match the length of the page title.
 2013-09-05 13:25:38 -05:00
David Boucha
86e0de1348 Correct rst underlines that were too short 2013-09-05 10:02:55 -06:00
Erik Johnson
e2bf055542 Add FAQ page to docs 
This was added per #7024.
 2013-09-05 09:10:47 -05:00
Matthew Williams
322b6055b2 docs: lxc and seed modules 2013-09-05 06:24:00 +00:00
Thomas S Hatch
f85c6e4566 Merge pull request #7020 from joehealy/windows_package_manager_doc_improvements_3 
Windows package manager doc improvements 3
 2013-09-04 08:01:12 -07:00
Thomas S Hatch
e4f2053fc7 Merge pull request #7019 from joehealy/windows_package_manager_doc_improvements_2 
further windows doc tweaks
 2013-09-04 08:00:39 -07:00
Joe Healy
9e65e208c4 Moved operation section nearer the top to give a high level overview 
before diving in.
 2013-09-04 11:35:37 +10:00
Joe Healy
282e5a813f further doc tweaks 2013-09-04 11:33:51 +10:00
Thomas S Hatch
81ba8889da Merge pull request #6998 from holmboe/patch-1 
Syntax of versionadded
 2013-09-03 12:19:15 -07:00
Henrik Holmboe
46fb3bcf28 Syntax of versionadded 2013-09-03 14:59:14 +02:00
Joe Healy
69b8df8c76 Improvements to the windows package manager page. 
The aim is to give a bit of a high level intro and also to
aid troubleshooting.
 2013-09-03 22:50:33 +10:00
Pedro Algarvio
931e0c4b05 Minor updates to include the external logging handler documentation. 2013-08-30 23:14:40 +01:00
Pedro Algarvio
f99d2a5065 Direct curious developers to the proper document. 2013-08-30 19:33:22 +00:00
Pedro Algarvio
e5a8b46b7e Updated logging documentation on a common place. 
* All logging information now resides on it's own document where all the currently documented features are explained.
* The master and minion logging configuration sections are now minimal and direct each option to the right place on the logging doc.
* A link to the logging doc was also added to the configuration document topic to help debugging issues when troubles are found.
* Headers fixed in the minion and master configuration docs
 2013-08-30 19:32:40 +00:00
Pedro Algarvio
f5f4caa852 Fix doctring code block syntax. 2013-08-30 19:32:40 +00:00
Pedro Algarvio
680ca716ec Add linkable ref's to the minion and master logging configuration sections. 2013-08-30 19:32:39 +00:00
shadowfax-chc
ae3d936644 Added reference docs for hgfs. 2013-08-26 17:42:52 -04:00
hvnsweeting
0091937b3d wrap match name in quote to make sure it work 2013-08-27 00:04:44 +07:00
Chris Rebert
ac43a79cee windows-package-manager.rst: remove nonsensical line 2013-08-23 10:59:15 -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
9353dcafd3 Revert "salt.modules.cmdmod renamed to salt.modules.cmd while enforcing absolute imports." 
This reverts commit 3fa341280b.
 2013-08-20 23:44:03 +01:00
Pedro Algarvio
3c523bf35f Revert "Since there are some links to salt.modules.cmdmod point the user to the correct module." 
This reverts commit 1599cd0ba5.
 2013-08-20 23:44:01 +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
d598a8074e Revert "Renamed djangomod module and state to django while enforcing absolute imports." 
This reverts commit 2f4d82b295.
 2013-08-20 23:43:56 +01:00
Pedro Algarvio
105a81ac27 Revert "Renamed gentoolkitmod module gentoolkit while enforcing absolute imports." 
This reverts commit 0f08e6088b.
 2013-08-20 23:43:54 +01:00
Pedro Algarvio
6659f0393f Revert "Renamed ldapmod module to ldap while enforcing absolute imports." 
This reverts commit c4c58370d2.
 2013-08-20 23:43:52 +01:00
Pedro Algarvio
580a666f60 Revert "Renamed localemod module to locale while enforcing absolute imports." 
This reverts commit 791dc53ca6.
 2013-08-20 23:43:50 +01:00
Pedro Algarvio
39b87cecfb Revert "Fixed documentation linking." 
This reverts commit 758e789d12.
 2013-08-20 23:43:48 +01:00
Pedro Algarvio
77803997f3 Revert "Renamed sysmod module to sys while enforcing absolute imports." 
This reverts commit 174a3e5b6c.
 2013-08-20 23:43:45 +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
174a3e5b6c Renamed sysmod module to sys while enforcing absolute imports. 2013-08-19 17:53:14 +01:00
Pedro Algarvio
758e789d12 Fixed documentation linking. 2013-08-19 17:40:07 +01:00
Pedro Algarvio
791dc53ca6 Renamed localemod module to locale while enforcing absolute imports. 2013-08-19 17:01:42 +01:00
Pedro Algarvio
c4c58370d2 Renamed ldapmod module to ldap while enforcing absolute imports. 2013-08-19 16:31:27 +01:00
Pedro Algarvio
0f08e6088b Renamed gentoolkitmod module gentoolkit while enforcing absolute imports. 2013-08-19 16:24:01 +01:00
Pedro Algarvio
2f4d82b295 Renamed djangomod module and state to django while enforcing absolute imports. 2013-08-19 16:13:38 +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
1599cd0ba5 Since there are some links to salt.modules.cmdmod point the user to the correct module. 2013-08-19 13:49:33 +01:00
Pedro Algarvio
3fa341280b salt.modules.cmdmod renamed to salt.modules.cmd while enforcing absolute imports. 2013-08-19 13:45:56 +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
Pedro Algarvio
afddbc8ee9 Merge pull request #6734 from terminalmage/issue6645 
Check /etc/hostname to derive minion id
 2013-08-15 16:29:32 -07:00
Erik Johnson
ce9b2728a0 Add documentation on how the minion id is derived 2013-08-15 18:03:38 -05:00
Seth House
bb8e617c57 Quiet Sphinx warning for deprecated Python API doc 2013-08-15 16:15:49 -06:00
Seth House
4d3012d9db Removed the "Python API" document in favor of the "Clients" doc 
This change moves some docs into class docstrings and some into the
clients/index.rst document.

Fixes #6705
 2013-08-15 16:00:02 -06:00
Erik Johnson
7d4739da2f Audit module documentation (A to D) 
This commit formats shell examples using bash code-block directives, so
that they get syntax highlighting. It also adds missing doc pages for
the ddns module.
 2013-08-14 19:53:09 -05:00
Seth House
95971d96d6 Added docs for each fileserver module 2013-08-14 17:19:56 -06:00
Seth House
73c11e298f Added fileserver modules to docs & index 2013-08-14 17:00:09 -06:00
Seth House
4d77e83d26 Added auth modules to the docs & index 2013-08-14 16:41:08 -06:00
Seth House
88671c18bb Added auth module docs 
O_o how has this not been done yet?
 2013-08-14 16:41:08 -06: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
Chris Rebert
25ff009ee9 Some docs copyediting & formatting 2013-08-10 22:43:12 -07:00
Pedro Algarvio
23052f6c95 Let the note stand out. 2013-08-10 16:06:30 +01:00
Pedro Algarvio
30828a7c01 Re add the JSON note lost in a rebase. 2013-08-10 15:39:04 +01:00
Pedro Algarvio
8185dbd75f Correct order and added missing options. 2013-08-10 15:37:38 +01:00
Pedro Algarvio
86521e62e8 salt-ssh does not provide --return. 2013-08-10 15:37:38 +01:00
Pedro Algarvio
19cdcd9970 Ordered the options output of salt-key added missing finger options. 2013-08-10 15:37:38 +01:00
Pedro Algarvio
a611a35fe1 salt-run also has the doc option. 2013-08-10 15:37:38 +01:00
Pedro Algarvio
836a557804 The timeout is now on a common document. 
Added the missing includes.
 2013-08-10 15:37:37 +01:00
Pedro Algarvio
fe43bb6558 Match option order and add missing --master. 2013-08-10 15:37:37 +01:00
Pedro Algarvio
13c7255980 Common daemon options are now on a separate document. 2013-08-10 15:37:37 +01:00
Pedro Algarvio
c304872ab1 General options are now on a common document. 2013-08-10 15:37:37 +01:00
Pedro Algarvio
3fd8ac7924 Logging options is now on it's own, common, document. 
* Added logging options for all the CLI tools that supported it and were lacking them.
 2013-08-10 15:37:37 +01:00
Pedro Algarvio
5268601ef6 Fix include path. 2013-08-10 15:37:37 +01:00
Pedro Algarvio
153475fa60 Target selection documentation now reside on it's own, common, document. 2013-08-10 15:37:37 +01:00
Pedro Algarvio
d009a82998 Add --output-file to the documentation. Minor formatting update. 2013-08-10 15:37:37 +01:00
Pedro Algarvio
f94e9f5e02 Add --force-color to the documentation. 2013-08-10 15:37:37 +01:00
Pedro Algarvio
9f47a1a0ad CLI Output options now reside on it's own, common, document. 2013-08-10 15:37:33 +01:00
Joseph Hall
e940f60c3c Merge pull request #6600 from TheRealBill/develop 
Adding some clarification about the use of --out=json and the output.
 2013-08-09 12:47:08 -07:00
Bill Anderson
5cc8142d2a Adding some clarification about the use of --out=json and the output. 2013-08-09 14:11:41 -05:00
Thomas S Hatch
f3d81dd4ef Merge pull request #6579 from terminalmage/develop 
Fix traceback on master when cp.push is used without file_recv being set
 2013-08-08 14:44:10 -07:00
Erik Johnson
8f03781ca9 Add missing master configuration file parameters 
This commit adds some recently-added master config options to the online
docs.
 2013-08-08 15:10:32 -05:00
Tomé Duarte
27e939f8c1 Adds example to Using Peer Communication with a specified matcher 
It took me a while to figure out I could do this, thought I'd clarify with an example.

Should more examples (for other matchers) be added?
 2013-08-08 21:08:39 +01: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
56fbf9cdbf Formatting fixes + added File Directory Settings 
Added the configuration parameters made available with a local
fileclient.
 2013-08-03 18:53:39 -05:00
Erik Johnson
f59cbc427f Formatting corrections 2013-08-03 18:53:05 -05:00
Seth House
bd58683e95 Added docs on the Events URL 2013-08-02 12:18:08 -06:00
Erik Johnson
ef9e7e5ab6 Merge pull request #6487 from s0undt3ch/features/doc-link-to-issues 
Replace issue links with the `:issue:` extlink extension.
 2013-08-01 17:56:53 -07:00
Erik Johnson
fa6170d9f4 Add explanation of the kwargs passed to states 2013-08-01 19:48:23 -05:00
Pedro Algarvio
87472875fe Replace issue links with the :issue: extlink extension. 2013-08-02 01:04:57 +01:00
Erik Johnson
c490a73517 pkg, not package 2013-08-01 13:01:49 -05:00
David Boucha
c552c6b537 Add doc on requiring an entire sls file 2013-08-01 11:03:21 -06:00
Erik Johnson
70e236d028 Docmentation tweaks in advance of 0.16.2 release 2013-07-31 20:43:37 -05:00
Tomé Duarte
7946bef5f3 Fix typo in pidfile code example. 2013-07-30 06:57:34 +01:00
David Boucha
5a8fb7a38d better wording in winrepo 2013-07-28 00:50:44 -06:00
David Boucha
81bf77f4d3 mention winrepo execution module 2013-07-28 00:48:04 -06:00
Joseph Hall
ed29fa103a Merge pull request #6376 from terminalmage/issue6322 
Add functions to manage file backups
 2013-07-27 16:27:13 -07: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
c2b2f675c0 Add file.restore_backup, file.delete_backup 
These functions allow you to restore a backup found with
file.list_backups, as well as remove unwanted backups.
 2013-07-27 17:49:55 -05:00
Thomas L. Kula
54a0746b4e Backoff when minion fails to connect 
NOTE: This is a potential change --- I haven't actually gotten a
test environment to try this out.

This adds a configuration option to the minion,
`acceptance_wait_time_max', that if set changes the acceptance
wait loop to add `acceptance_wait_time' seconds to the wait between
each iteration, up to this maximum value.

POTENTIAL FIX: Issue #5813
 2013-07-27 16:51:38 -04:00
Erik Johnson
13e9444329 Add file.list_backups execution function 
This commit adds a function that will list the available backups for a
given path.
 2013-07-27 14:48:20 -05:00
Joseph Hall
7062ff4366 Merge pull request #6344 from mikadosoftware/minor-doc-fix 
Trivial doc spelling fix
 2013-07-27 07:14:06 -07:00
Paul Brian (lifeisstillgood)
fe4559101e Trivial doc spelling fix 
It is trivial but it is my first commit / pull request so useful for
checking the process is correct. And it has a semicolon
 2013-07-27 13:07:44 +01:00
Thomas S Hatch
45cb885301 Merge pull request #6331 from terminalmage/docs 
Lots of docs on salt fileserver environments
 2013-07-26 10:33:24 -07:00