Commit Graph

1819 Commits

Author SHA1 Message Date
Seth House
3d9351b166 Fixed incorrect module name in formula docs
formula_utils.py was an unfinished thought that it may make sense to
break out formula functions into a standalone module at some point.
2013-09-17 12:56:08 -06:00
Joseph Hall
76833df1ee Merge pull request #7293 from holmboe/susefirewall2-doc
Add documentation for SuSEfirewall2
2013-09-17 06:52:04 -07:00
Henrik Holmboe
c9767da312 Update repos filename for SuSEfirewall.d configuration file 2013-09-17 15:30:55 +02:00
Henrik Holmboe
19acd1661e Remove unused salt.ufw anchor and more minor edits 2013-09-17 15:28:25 +02:00
Henrik Holmboe
df0ebb78b7 Add documentation for SuSEfirewall2 2013-09-17 15:27:23 +02:00
Erik Johnson
9e32266b24 Add note on test.ping to FAQ
This is a common question in #salt.
2013-09-16 13:05:35 -05:00
Erik Johnson
97015a5db4 Add more information about salt-call
This adds additional information both to the walkthrough and the
"troubleshooting" page.
2013-09-12 17:11:10 -05:00
Erik Johnson
6f96971c94 Update "current release" link to 0.16.4 2013-09-12 17:10:45 -05:00
Mickey Malone
bf5ea55334 Merge remote-tracking branch 'upstream/develop' into feature_sqlite3_returner 2013-09-12 06:36:03 -05:00
Forrest Alvarez
168776a639 updated troubleshooting index to add selinux commands for CentOS/RHEL 6. 2013-09-12 05:01:51 +00:00
Seth House
4e0f523ede Added configuration entries to allow translating Salt docs 2013-09-11 22:23:46 -06:00
Mickey Malone
8e8ea379e9 Added the sqlite3 returner to the docs. Fixed spelling mistakes. 2013-09-11 22:39:54 -05:00
Henrik Holmboe
009326f7f9 Type in cloud_controller.rst 2013-09-11 21:36:31 +02:00
Henrik Holmboe
3dfd6f07e5 Enable to virt.init on an ESX host
WARNING: This is currently untested on a KVM/QEMU host, so this might
very well introduce a regression. Please review.
2013-09-11 16:38:15 +02:00
Erik Johnson
3d3c2fefb8 Add note regarding PATH issues to FAQ 2013-09-10 15:59:10 -05:00
Joseph Hall
dde02828fd Merge pull request #7146 from joehealy/doc_typos
Fix for typos picked up by lintian
2013-09-10 05:23:13 -07:00
Joe Healy
6c471a6d4a Fix for typos picked up by lintian 2013-09-10 22:10:47 +10:00
Henrik Holmboe
4cb197c04a Align comments 2013-09-10 13:45:00 +02:00
Henrik Holmboe
9591465b32 Fix mid-sentence stop, no reference
In addition to some other minor changes.
2013-09-10 13:41:53 +02:00
Joseph Hall
46f8f15ad2 Adding additional information on firing events 2013-09-09 18:06:05 -06:00
Erik Johnson
338e4b0cf1 Typo fixes and further FAQ tweaks 2013-09-09 15:57:38 -05:00
Erik Johnson
10d671d9da Fix broken link in FAQ
The link to "state.hightstate" in the 3rd bullet point was not properly
formed, so the hyperlink failed to create.

Also massaged the paragraphs explaining the difference between the
cmd.run and cmd.wait states.
2013-09-09 12:14:21 -05:00
Erik Johnson
f333641e3d Add new ssh doc pages to toctree 2013-09-09 11:11:03 -05:00
Erik Johnson
ccc6a99747 Link directly to id param docs 2013-09-09 11:10:58 -05:00
Joe Healy
2af9e92515 Tweaks to faq with aim of aiding beginners 2013-09-10 00:15:49 +10:00
Thomas S Hatch
8f588a0881 Add initial bare bones roster docs 2013-09-08 23:00:45 -06:00
Thomas S Hatch
c05d4892de Add initial salt-ssh docs 2013-09-08 22:39:42 -06:00
Erik Johnson
0c29864863 docs update: add augeas state to toctree 2013-09-06 18:46:25 -05:00
Erik Johnson
234a032867 Add release notes for 0.16.4 2013-09-06 11:29:14 -05:00
Thomas S Hatch
8c142f3958 Merge pull request #7085 from holmboe/apt-held-state
Apt held state
2013-09-05 19:59:10 -07:00
Henrik Holmboe
e7861fbc0b This header looked weird
At http://docs.saltstack.com/index.html#targeting it looked like sheit,
as well as the Table Of Contents at the top right on the same page.
2013-09-06 02:56:11 +02: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
9f6eb0b8af Merge pull request #7076 from terminalmage/docs
add missing period
2013-09-05 12:01:07 -07:00
Erik Johnson
01f27df7ac add missing period 2013-09-05 13:59:48 -05:00
Seth House
ebce80d84c Merge pull request #7075 from terminalmage/docs
A bunch of docs commits
2013-09-05 11:58:30 -07:00
Erik Johnson
18ddf58868 Grammar fix
"How to can get involved" -> "How to get involved"
2013-09-05 13:47:38 -05: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
be039d45b3 Tweak wording for FAQ link in docs index 2013-09-05 13:45:15 -05:00
Erik Johnson
e275ca9921 Fix sphinx build warnings (new modules not in toctree) 2013-09-05 13:43:46 -05:00
Erik Johnson
b603274ecd Add notes on GitPython issue in salt<=0.16.3 2013-09-05 13:43:08 -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
Pierre DOUCET
aee8b60f79 Adding "wmi windows installer provider" to docs. Fixes #7030 2013-09-05 13:38:24 +02: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
Henrik Holmboe
4fe8c529c0 Some minor changes to the documentation 2013-09-04 14:48:17 +02: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
Seth House
82d1fe8409 Changed package-map.jinja references to map.jinja 2013-09-03 13:24:27 -06:00
Seth House
cbf0b79ab5 Updated Salt version requirements for Formulas 2013-09-03 13:24:27 -06: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
Thomas S Hatch
29c562bb2b Merge pull request #6953 from s0undt3ch/features/even-more-logging-power
Support External Logging Handlers
2013-08-31 19:35:34 -07:00
Erik Johnson
c86c855279 Better way of emphasizing S, L, and S in docs
Pull req #6972 negated a 100% intentional design decision, intended to
draw attention to the S, L, and S in "SaLt State file" to show why they
are called "SLS files". This commit reverts that change, and bolds the
S, L, and S so that this is more apparent.
2013-08-30 18:05:38 -05:00
Pedro Algarvio
931e0c4b05 Minor updates to include the external logging handler documentation. 2013-08-30 23:14:40 +01:00
Ajith Antony
f880d57af3 SaLT -> Salt 2013-08-30 15:41:15 -05: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
0cdfabf24c Allow the conf-log role to link to the logging documentation. 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
Colton Myers
0acf9a5383 Remove deprecated matchers from compound matcher 2013-08-29 11:26:59 -06:00
Thomas S Hatch
94133c17e7 Merge pull request #6948 from hvnsweeting/reactor_doc
add doc on fire an event, add commas to improve readability
2013-08-29 08:21:51 -07:00
Pedro Algarvio
ebf848dfb4 Add an anchor to the enable Travis-CI note. 2013-08-29 10:52:38 +00:00
hvnsweeting
66e7f305e8 add doc on fire an event, add commas to improve readability 2013-08-29 14:11:43 +07:00
shadowfax-chc
ae3d936644 Added reference docs for hgfs. 2013-08-26 17:42:52 -04:00
David Boucha
39d00fab81 Add doc showing how to install a Salt Master 2013-08-26 11:27:50 -06:00
hvnsweeting
0091937b3d wrap match name in quote to make sure it work 2013-08-27 00:04:44 +07:00
Joseph Hall
f064e2beba Merge pull request #6885 from lloydchang/develop
Clarify OS X instructions toward success
2013-08-25 04:48:48 -07:00
Lloyd Chang
54ad96538d Clarify OS X instructions toward success 2013-08-25 00:10:24 -07:00
Erik Johnson
c4e85c63e9 Docs formatting fixes 2013-08-24 23:19:54 -05:00
Marc Liyanage
1dfdd943af Small documentation tweak, started out by replacing "it's" with "its" and added some other minor changes. 2013-08-23 13:38:10 -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
David Boucha
7d353d91ca Merge pull request #6844 from terminalmage/docs
Add more information on overriding providers
2013-08-21 17:05:50 -07: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
Chris Rebert
193bd841ac deprecations.rst: fix grammar: it's => its 2013-08-21 13:42:39 -07: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
b6e7c6836e h3 was too big but it can be the same size of p nor h2. 2013-08-21 00:05:48 +01:00
Pedro Algarvio
949c882278 Add documentation to style guide as to why absolute imports should be avoided. 2013-08-21 00:04:21 +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
Joseph Hall
490f908604 Merge pull request #6810 from hulu/copyedit
copyedit state ordering docs
2013-08-20 12:31:34 -07:00
Chris Rebert
d854574bf9 copyedit state ordering docs 2013-08-20 12:21:26 -07:00
Chris Rebert
3d20313ef8 doc/topics/conventions/style.rst: fix typo 2013-08-20 12:14:52 -07:00
Thomas S Hatch
e263e9a7b9 Add state_auto_order docs 2013-08-20 11:55:24 -06:00
Thomas S Hatch
92bbae7e0d Merge pull request #6784 from s0undt3ch/hotfix/absolute-imports
no *mod.py modules / use absolute imports
2013-08-20 09:33:35 -07:00
Michael Grosser
d3a95b78cd Fix typo. 2013-08-20 02:30:55 +02:00
Seth House
b8fa283b61 Added upcoming Salt presentations to sidebar 2013-08-19 17:21:39 -06:00
Seth House
4c1a8f644b Added section on package-map.jinja 2013-08-19 14:43:54 -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
Thomas S Hatch
87e196a5cf Add note on vertical function defs 2013-08-18 23:30:57 -06:00
Jason Sommer
201b4f8776 Added gitfs_root option 2013-08-17 20:14:57 -05:00
Seth House
5b81160804 Fleshed out the "Writing Formula" section 2013-08-16 23:33:21 -06:00
Seth House
5f65993b18 Improved Formula installation instructions
Refs #6739
2013-08-16 23:33:21 -06:00
Seth House
e5ab0c9a62 Expanded on Formulas Salt version requirements 2013-08-16 23:33:21 -06:00
Erik Johnson
a59b5149c6 Clarify the minion ID generation docs 2013-08-15 22:23:14 -05:00
Seth House
a97817abfa Added note about Salt versions to formulas doc 2013-08-15 19:20:56 -06: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
Thomas S Hatch
0c8a11dda3 Merge pull request #6610 from erchn/develop
improve file.recurse performance v2
2013-08-14 14:35:15 -07:00
Erik Johnson
177d4009a2 Cleanup docstrings in modjk state/module
Fixed spelling/grammar errors, improved formatting, and introduced links
to improve doc navigation.
2013-08-13 11:39:26 -05: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
4eaff920e9 Fix grammar, spelling, formatting in 0.16.2 release notes
55d9586 introduced some errors that needed to be corrected, this commit
corrects them.
2013-08-12 20:12:27 -05:00
Thomas S Hatch
01b7dd611e Merge pull request #6649 from pille/patch-1
Update 0.16.2.rst for #6638
2013-08-12 16:51:44 -07:00
Erik Johnson
8eeaf6c90f Link to 0.16.0 release notes from 0.16.2/0.16.3
The release notes for these two versions make mention of 0.16.0, so this
commit makes those into links for easier navigation.
2013-08-12 14:37:59 -05:00
Colton Myers
6d4064e355 Remove release note about osfinger (it was reverted in final release) 2013-08-12 13:15:04 -06:00
Erik Johnson
bc6c5fff17 docs: make "current release" a link to the release notes 2013-08-12 14:10:34 -05:00
pille
55d9586d47 Update 0.16.2.rst
fixes #6638
2013-08-12 21:08:23 +02:00
Erik Johnson
fc2ec7d3f5 Fix current release in docs 2013-08-12 13:50:46 -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
David Boucha
18d574f269 Add link to amd64 installer. Fix version #s 2013-08-11 18:02:51 -06:00