Commit Graph

886 Commits

Author SHA1 Message Date
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
Thomas S Hatch
b19c17cff2 Merge pull request #7362 from piffio/gitfs-documentation-tips
Add cleaner explanation of environment mapping
2013-09-19 16:28:09 -07:00
Sergio Visinoni
f95c0d67d7 Add cleaner explanation of environment mapping
Explicitely state that the 'master' branch is automagically mapped
to the 'base' environment.

Also mention the fact that top.sls files are merged from the different
branches, which suggests a setup where top.sls is only present in
the 'master' branch.
2013-09-19 17:00:46 -05:00
Thomas S Hatch
f241c4c5e1 update release notes 2013-09-18 22:02:43 -06:00
Chris Rebert
1de782385f copyedit 0.17.0 release notes draft 2013-09-18 18:24:00 -07:00
Thomas S Hatch
bfb56ded19 start on 0.17.0 release notes 2013-09-18 18:55:51 -06:00
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
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
Forrest Alvarez
168776a639 updated troubleshooting index to add selinux commands for CentOS/RHEL 6. 2013-09-12 05:01:51 +00: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
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
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
234a032867 Add release notes for 0.16.4 2013-09-06 11:29:14 -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
b603274ecd Add notes on GitPython issue in salt<=0.16.3 2013-09-05 13:43:08 -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
Henrik Holmboe
4fe8c529c0 Some minor changes to the documentation 2013-09-04 14:48:17 +02: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
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
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
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
David Boucha
39d00fab81 Add doc showing how to install a Salt Master 2013-08-26 11:27:50 -06: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
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
949c882278 Add documentation to style guide as to why absolute imports should be avoided. 2013-08-21 00:04:21 +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
Chris Rebert
3d20313ef8 doc/topics/conventions/style.rst: fix typo 2013-08-20 12:14:52 -07:00
Michael Grosser
d3a95b78cd Fix typo. 2013-08-20 02:30:55 +02:00
Seth House
4c1a8f644b Added section on package-map.jinja 2013-08-19 14:43:54 -06:00
Pedro Algarvio
3fa341280b salt.modules.cmdmod renamed to salt.modules.cmd while enforcing absolute imports. 2013-08-19 13:45:56 +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
Erik Johnson
ce9b2728a0 Add documentation on how the minion id is derived 2013-08-15 18:03:38 -05: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
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
pille
55d9586d47 Update 0.16.2.rst
fixes #6638
2013-08-12 21:08:23 +02: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
David Boucha
70a3827273 Add win32 installer link to docs 2013-08-11 18:02:05 -06:00
Erik Johnson
cf365f77cd Convert shell command examples to bash code-block
This commit modifes a number of files which have command-line examples
so that the code-block directive is used. This provides more
visually-appealing syntax highlighting.

More commits like this will follow, this commit is part of an overall
documentation audit that I am performing.
2013-08-10 21:55:51 -05:00
Erik Johnson
36cc876450 add release notes for 0.16.3 2013-08-09 12:34:22 -05:00
Thomas S Hatch
cb3beb5e76 Minior changes to manage openstack expectations 2013-08-07 16:25:17 -06:00
Seth House
f0e7211893 Added initial documentation on Salt Formulas 2013-08-07 14:34:47 -06:00
Seth House
db4d7bcb59 Added rST anchors to pillar and GitFS for easy cross-referencing 2013-08-07 14:34:47 -06:00
Erik Johnson
4ce370b679 improve formatting in remote execution tutorial 2013-08-06 19:21:39 -05:00
Erik Johnson
02cd6d1868 Fix additional broken links
This takes care of the last of the warnings generated by sphinx when
building the HTML docs.
2013-08-03 23:35:50 -05:00
Erik Johnson
c78a06c833 Remove links to nonexistant pages
Would be good to write these eventually, but for now don't try linking
to them since they do not exist.
2013-08-03 19:12:09 -05:00
Erik Johnson
6e5eb5ad5b Fix broken link in 0.16.2 release notes 2013-08-03 19:11:30 -05:00
Erik Johnson
beedffc62c Added links, formatting fix for standalone minion docs 2013-08-03 18:54:30 -05:00
David Boucha
a99c8e721f Add links to windows Salt 0.16.2 installers 2013-08-02 11:09:10 -06:00
Erik Johnson
7700966174 Merge pull request #6489 from terminalmage/docs
Replace references to 0.16.1 with 0.16.2
2013-08-01 18:11:38 -07:00
Erik Johnson
eb339ef1fa Replace references to 0.16.1 with 0.16.2 2013-08-01 20:10:45 -05: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
dbfc6448fa Remove unnecessary question mark 2013-08-01 19:47:46 -05:00
Pedro Algarvio
87472875fe Replace issue links with the :issue: extlink extension. 2013-08-02 01:04:57 +01:00
Erik Johnson
8205940ff6 Fix RabbitMQ link in 0.16.2 release notes 2013-08-01 18:02:59 -05:00
Erik Johnson
38901bc110 Fix rst syntax in 0.16.2 release notes 2013-08-01 17:51:39 -05:00
Erik Johnson
61c30d3a50 Add fix for #6464 to 0.16.2 release notes 2013-08-01 16:20:15 -05:00
David Boucha
b3bff31a40 Add example of using expr_form 2013-08-01 14:29:49 -06:00
Erik Johnson
b2c960fadb Add fix for #6471 to 0.16.2 release notes 2013-08-01 11:53:15 -05:00
Erik Johnson
f035d20b6a Add additional bugfixes to 0.16.2 release notes 2013-08-01 10:09:55 -05:00
Erik Johnson
4ad4f2f751 Added a few more changes to 0.16.2 release notes 2013-07-31 23:09:36 -05:00
Erik Johnson
59a805607c Add release notes for 0.16.2 2013-07-31 22:55:52 -05:00
Forrest
a860e5d002 Fixed a typo in pki minion information.
Modified path to properly reference the key location.
2013-07-29 22:35:28 -07:00
Erik Johnson
17d206b783 Punctuation fix in pillar docs
Sentence is missing a period at the end.
2013-07-29 19:56:06 -05:00
Erik Johnson
c3ca853582 Use double-colon to make cmdline example use PRE tag in docs 2013-07-28 18:06:37 -05:00
Jason Swindle
4c5da1347e Updating Grains doc to show JINJA in Top file matching with grains. 2013-07-27 16:51:07 -05:00