Commit Graph

1036 Commits

Author SHA1 Message Date
rallytime
5789d4800c Clarifications for require, watch, and prereq in requisites documentation 2014-04-21 13:40:00 -06:00
Seth House
85c929112c Documented using the loader interface from the Python level 2014-04-18 17:14:35 -06:00
Seth House
1610bda84b Pulled Jinja docs back into the code
We were accumulating two versions of the docs since people update
docstrings as they hack but only one was getting rendered on the site.

Hopefully this is a happy middle-ground by spreading the docs around a
bit and pulling them in to a central location.
2014-04-17 14:24:15 -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
Joseph Hall
7aa7cd9944 Merge pull request #12010 from rallytime/documentation_change
Documentation for returner config values pulled from minions
2014-04-15 19:19:36 -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
rallytime
0f77393961 Documentation for returner config values pulled from minions 2014-04-15 11:42:52 -06:00
Seth House
ca028dae3c Add docs for the saltnado netapi module 2014-04-14 22:53:17 -06:00
Mike Place
0c9f7eb356 Merge pull request #11983 from xenuser/fix_11961
Refs #11961: Add a short note regarding --show-timeout in the salt manpage
2014-04-14 13:15:10 -06:00
Valentin Hoebel
ff07ccac94 Refs #11961: Add a short note regarding --show-timeout in the salt manpage 2014-04-14 21:11:01 +02:00
Pedro Algarvio
2b2754d683 Don't encourage bad **kwargs usage. 2014-04-13 14:38:04 +01:00
Erik Johnson
bc850cfdd3 Add new docs RST autosummary page 2014-04-12 11:23:34 -05:00
Erik Johnson
c351f8b76e Add svnfs to toctree 2014-04-11 16:17:47 -05:00
Seth House
640f613364 Added a full but simplistic example of writing a state module 2014-04-11 14:08:53 -06:00
Erik Johnson
910393fa3c Add new params to master config docs
Also fixed up some of the wording on the other recently-added remote
fileserver configuration parameters.
2014-04-11 11:40:01 -05:00
Xavier Barbosa
3b9891b1dc implement merging strategy into pillar 2014-04-09 06:45:11 +02:00
Xavier Barbosa
ce2cf98518 implements sls renderer 2014-04-09 06:45:10 +02:00
Erik Johnson
0f5160345b Add new params to master docs 2014-04-08 16:13:29 -05:00
Joseph Hall
df9b0af154 Merge pull request #11810 from terminalmage/minionfs-enhancements
Minionfs enhancements
2014-04-07 11:05:54 -06:00
Erik Johnson
ae11b2678a Add new minionfs params to docs 2014-04-07 11:29:24 -05:00
Thomas Güttler
7d25e086d3 "Full List of Renderes" was a sub section of "Examples" before. 2014-04-07 09:27:21 +02:00
Colton Myers
5b6b30e896 Add note about multiple extends of a single state 2014-04-03 15:19:34 -06:00
Johannes
1434539af7 Fix typo 2014-03-30 15:48:15 +00:00
Tim O'Guin
db6f276d01 added /var/run/salt to nonroot docs 2014-03-28 10:18:57 -05:00
Thomas S Hatch
52ba39bb58 Merge pull request #11513 from pass-by-value/document_output_color_codes
Add a note about outputter color codes
2014-03-27 09:42:29 -06:00
Erik Johnson
5e1870d1c5 Add info on per-remote gitfs_base to master docs 2014-03-26 16:29:07 -05:00
Aditya Kulkarni
2b97fbfd1b Add a note about outputter color codes 2014-03-26 14:16:59 -04:00
Joseph Hall
cbe3060b6c Updating docs for etcd 2014-03-25 08:24:15 -06:00
Erik Johnson
18bb7147a4 Fix RST syntax errors 2014-03-24 11:12:56 -05:00
Erik Johnson
f9c6972ecd add proxmox to toctree 2014-03-24 11:12:32 -05:00
Pedro Algarvio
9ec00d2834 Fix wrong permissions 2014-03-23 18:22:35 +00:00
Frank Klaassen
9da568d7f9 Support for Proxmox in Salt-Cloud 2014-03-22 17:44:59 +01:00
Thomas S Hatch
21c4344f2e Clarify and update non-root documentation 2014-03-20 16:00:10 -06:00
Erik Johnson
83063c8d68 Fix broken links and other sphinx errors 2014-03-17 17:17:18 -05:00
Erik Johnson
3c1d8fa3ce Remove ibmsce pages from docs configuration
This driver was removed from salt-cloud, but the references to it in the
docs were not.
2014-03-17 17:15:47 -05:00
Mike Place
fc89a3e9c4 Rename state ordering section 2014-03-14 14:19:32 -06:00
Mike Place
cfa859c76e Reconsile docs and fix build warnings. 2014-03-14 14:18:56 -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
4c7409a6d1 Hide function aliases from docs 2014-03-13 21:12:27 -05:00
Erik Johnson
fc062e5d27 Move OverState and state.sls docs to new location 2014-03-13 20:59:28 -05:00
Seth House
534343c1cf Added docs for the /stats URL 2014-03-10 17:06:51 -06:00
Joseph Hall
8f8577e336 Merge pull request #11069 from s0undt3ch/hotfix/minor
Minor corrections
2014-03-08 05:35:33 -07:00
Pedro Algarvio
ba80b2ecfa Show how to use __virtualname__ 2014-03-08 11:03:20 +00:00
Henrik Holmboe
ec769d4a35 Add survey to runner index 2014-03-08 11:02:33 +01:00
Seth House
a06ccfef2f Added docs for the extension_modules setting
Refs #11030
2014-03-07 15:13:41 -08:00
Thomas S Hatch
ed0779cc9a Merge branch 'easier-writing-runners-doc' of git://github.com/felixhummel/salt into felixhummel-easier-writing-runners-doc
Conflicts:
	doc/ref/runners/index.rst
2014-03-07 15:01:18 -07:00
Thomas S Hatch
8c6c608958 Merge branch 'serializers' of git://github.com/johnnoone/salt into johnnoone-serializers
Conflicts:
	doc/topics/yaml/index.rst
2014-03-07 14:53:03 -07:00
Felix Hummel
98125a18f5 How to enable custom runners 2014-03-06 17:32:37 +01:00
Mathieu Le Marec - Pasquet
972efcaf37 salt.cloud.lxc: lxc provider 2014-03-06 16:09:39 +00:00
Tarjei Husøy
aec6b11d9a Fix inconsistent header formatting in docs 2014-03-05 22:21:11 +01:00
Erik Johnson
edc39496df Correct docs inaccuracy
state_verbose does not default to False. This was changed a long time
ago but the docs were never updated.
2014-03-02 09:56:14 -06: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
12481b9e38 Added ref anchor for renderer 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
d9d8e2c2b4 Added ref anchor for peer 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
d4a71b2bc0 Added ref anchor for file server docs 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
Jens Rantil
302629bc72 Fix typo: maintinance => maintenance 2014-02-27 14:59:24 +01:00
Mike Place
2637fc689f Docs build cleanly! Yay! 2014-02-26 13:32:33 -07:00
Mike Place
0ce328c7e7 Fix line length 2014-02-26 13:32:33 -07:00
Mike Place
fd15b3372b Now compiling cleanly except for GCE. 2014-02-26 13:32:33 -07:00
Mike Place
d7873621b1 Wrapping up sub-TOCs. 2014-02-26 13:32:33 -07:00
Mike Place
826bad4cfb Merge conflict and rebase.
Conflicts:
	doc/ref/renderers/index.rst
2014-02-26 13:32:08 -07:00
Mike Place
6af7ff5dff First pass at refactoring Salt documentation. 2014-02-26 13:31:11 -07:00
Erik Johnson
f725f00614 Add new config parameters to the docs 2014-02-25 22:54:25 -06:00
Thomas S Hatch
205f17236b Merge pull request #10706 from terminalmage/docs
Clean up img module docs
2014-02-24 13:54:00 -08:00
Erik Johnson
7f0971c2b3 Hide aliased function name 2014-02-24 14:11:54 -06:00
Erik Johnson
775db263eb Add znc module to modules toctree 2014-02-24 13:58:54 -06:00
Erik Johnson
283a1faba1 add automodule file for new znc module 2014-02-24 13:58:44 -06:00
Henrik Holmboe
de1548aeb0 Missing comma 2014-02-24 14:21:57 +01:00
Henrik Holmboe
09321799bf Add automodule and autosummary doc for the pyobjects renderer 2014-02-24 14:21:02 +01: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
Thomas S Hatch
4321a69180 Merge pull request #10459 from cachedout/getting_started
Getting started
2014-02-20 10:55:37 -07:00
Xavier Barbosa
6be9f13224 document aggregation 2014-02-20 18:27:00 +01:00
Thomas S Hatch
92faa93295 Merge pull request #10606 from terminalmage/docs
Fix sphinx build errors/warnings, add new modules to toctree
2014-02-20 10:21:33 -07:00
Mike Place
e32b0077d8 Moved YAML documentation into renderer page.
Conflicts:
	doc/topics/yaml/index.rst
2014-02-20 10:15:50 -07:00
Xavier Barbosa
d94e518aa6 expose documentation of serializers 2014-02-20 12:00:22 +01:00
Erik Johnson
630f79ae3c Add recent modules to docs 2014-02-20 04:27:05 -06:00
Erik Johnson
d306b0d9a2 Add svnfs params to master config docs 2014-02-20 03:21:36 -06:00
Thomas S Hatch
553a4fe10f Merge pull request #10598 from cachedout/2_19_docfix
2 19 docfix
2014-02-19 19:11:12 -07:00
Mike Place
9ff11cbd56 New module docs. 2014-02-19 16:58:24 -07:00
Mike Place
362931561d States index re-write for clarity. 2014-02-19 15:36:14 -07:00
Thomas S Hatch
8b5a453822 Merge pull request #10572 from terminalmage/hgfs-mountpoints
Add hgfs mountpoints and per-repo configuration params
2014-02-19 14:26:26 -07:00
Mike Place
9e56b16ab2 Runner index re-write for clarity. 2014-02-19 14:21:48 -07:00
Mike Place
2a6ee163f0 Renderer index re-write for clarity. 2014-02-19 14:16:14 -07:00
Mike Place
6186eeab68 Renderer index re-write for clarity. 2014-02-19 13:55:34 -07:00
Mike Place
7001c9dcc3 Big re-write of the modules reference. Standardized on 'execution module' as a term to avoid confusion. Cleaned up a lot of weasel-words and made the phrasing more declarative. 2014-02-19 12:51:53 -07:00
Mike Place
c9b58df5f6 Added more modules to documentation index. 2014-02-19 10:34:11 -07:00
Mike Place
f12194c146 Change decorator example to setup logging. Closes #10584. 2014-02-19 09:38:38 -07:00
Erik Johnson
a0f9213679 Add new hgfs features to docs 2014-02-18 21:01:42 -06:00
Thomas S Hatch
7207f9c179 Merge pull request #10502 from kadel/doc-fixes
doc: fix references in salt.modules.pkg
2014-02-17 14:55:55 -07:00
Thomas S Hatch
c61690cdcf Merge pull request #10468 from terminalmage/gitfs-mountpoints
Add gitfs "mountpoints" and per-remote config params
2014-02-17 14:48:40 -07:00
Tomas Kral
7c4c543fdd doc: fix references in salt.modules.pkg 2014-02-17 13:54:42 +01:00
Erik Johnson
bccd82aacf Added additional docs on gitfs mountpoints and per-remote params 2014-02-15 01:19:02 -06:00
Erik Johnson
b24af2c8b3 Add gitfs_mountpoint master conf parameter to docs 2014-02-15 00:30:47 -06:00
Erik Johnson
b69234e744 Alias lowercase versions of functions 2014-02-12 16:45:39 -06:00
Thomas S Hatch
a7baf5936c Revert "add sequence filter for jinja"
This reverts commit cbe04b8231.
2014-02-11 15:59:22 -07:00
Xavier Barbosa
cbe04b8231 add sequence filter for jinja 2014-02-11 20:42:40 +01:00
Erik Johnson
9773caba98 Adjust docs to reflect additional hgfs changes 2014-02-08 13:23:54 -06:00
Erik Johnson
ed2190b65e Add hgfs config params to docs 2014-02-08 05:25:07 -06:00
Russell Ballestrini
773e2f85ad Update runners index.rst
Adjusted the wording for accuracy.
2014-02-07 20:27:40 -05:00
Seth House
9142672749 Updated example for getting minion opts dictionary 2014-02-05 15:20:43 -07:00
Bogdan Radulescu
ff4342adcb Add two options in the salt-ssh documentation 2014-02-05 16:32:16 +02:00
Erik Johnson
617c04c6ac Rename apt to aptpkg in sphinx configuration 2014-02-04 16:26:13 -06:00
Erik Johnson
ffd189cc7b Add info about root_dir and the options to which it is prepended 2014-02-04 15:46:22 -06:00
pille
3eee5d8697 fix doc typo 2014-02-03 11:19:11 +01:00
Ted Strzalkowski
e2949d865d Updated requisites docs to only monospace sls keys 2014-01-31 19:54:21 -08:00
Thomas S Hatch
15c728bf02 Merge pull request #10086 from dangarthwaite/states_run_on_minions_8389
states_run_on_minions_8389
2014-01-31 10:24:40 -08:00
Dan Garthwaite
1edaf7c345 states_run_on_minions_8389 2014-01-31 12:43:51 -05:00
Joseph Hall
6710ca1605 Merge pull request #10050 from jeremyfelt/fix-file_root
s/environmentt/environment/ in new file_roots.rst documentation
2014-01-30 17:03:43 -08:00
Seth House
fd92f55ca4 Moved docs from method to module level 2014-01-30 14:32:43 -07:00
Seth House
091a578b12 Added Webhook to docs 2014-01-30 12:05:10 -07:00
Matthew Williams
490338850a add lxc runner to index.rxt 2014-01-30 14:03:15 -05:00
Matthew Williams
df3c875d5a add docs for lxc runner 2014-01-30 00:19:21 -05:00
jeremyfelt
1562acfbb3 s/environmentt/environment/ in new documentation
Introduced in 85cbec9
2014-01-29 20:40:02 -08:00
Forrest Alvarez
c1d8fca8a5 Fixed a typo in the file_roots docs, 2014-01-29 20:52:08 +00:00
Forrest Alvarez
ff4a01d5ed Updated the file_roots docs to show an example using multiple file roots for different environments. 2014-01-29 20:51:03 +00:00
Thomas S Hatch
6029515fd0 Merge pull request #9985 from makinacorpus/graindirs
Custom grains directories
2014-01-29 07:25:28 -08:00
Seth House
7b50bd1352 Added cmd_batch to Python API documentation 2014-01-28 12:35:02 -07:00
Mathieu Le Marec - Pasquet
11ff89000b Custom grains directories 2014-01-28 13:40:55 +01: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
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