Commit Graph

726 Commits

Author SHA1 Message Date
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