Commit Graph

1333 Commits

Author SHA1 Message Date
Erik Johnson
a0d0db6ed1 Add docs on installing w/easy_install 2013-04-07 17:05:31 -05:00
Erik Johnson
a099d8df57 Update renderer docs
Remove reference to the python renderer being added in the future, as it
has been around for some time.
2013-04-07 00:51:19 -05:00
Erik Johnson
0d1a450e60 Remove unnecessary MacOS metadata file 2013-04-07 00:47:22 -05:00
Joseph Hall
94a30a1169 Merge pull request #4406 from timhollinger/develop
Changed to 3rd person
2013-04-05 18:07:20 -07:00
Tim Hollinger
c773fc115c Changed to 3rd person
Changed to 3rd person
2013-04-05 18:56:42 -06:00
Thomas S Hatch
2ff8e8ee20 Merge pull request #4403 from timhollinger/develop
minor fixes
2013-04-05 16:42:17 -07:00
Tim Hollinger
246a411178 minor change
s/to/as  line 6
2013-04-05 17:41:39 -06:00
Tim Hollinger
50917223c2 minor fixes
Fixed Debian / Redhat httpd
2013-04-05 17:25:46 -06:00
Chris Rebert
878e63d331 fix terminology: "PEP 8" the doc; "pep8" the script
PEPs aren't normally referred to with a dash (e.g. "PEP-8"), but rather with a space.
    (Note how PEPs cross-reference each other.)
"PEP-08" is completely nonstandard.
    Python 2 PEPs run into the triple-digits; Python 3 PEPs are/were 4-digit (3xxx).
    So padding it to 2 digits is completely weird.
2013-04-05 15:28:24 -07:00
Thomas S Hatch
440345db85 Merge pull request #4398 from timhollinger/develop
Improved readability, grammar
2013-04-05 13:55:11 -07:00
Tim Hollinger
96fa0c48f9 Changed to 3rd person
Changed to 3rd person
2013-04-05 14:52:51 -06:00
Colton Myers
f457c23683 Add link to issue from pep8 2013-04-05 14:29:48 -06:00
Colton Myers
a7b7c97506 Fix typos and add more clarification 2013-04-05 14:22:34 -06:00
Tim Hollinger
98ca53c218 Fixed 80 column width
Due to fussy programmers that still live with 1972 standards :P
2013-04-05 14:20:36 -06:00
Colton Myers
815be866d3 Add documentation to 'fix' pep8 and flake8 2013-04-05 14:11:32 -06:00
Tim Hollinger
164e3c796f Improved readability, grammar
Swapped 'a' for 'an' where necessary.  Changed verb agreement.
Uncluttered scentences.
2013-04-05 13:49:51 -06:00
Thomas S Hatch
9ea128050e Last time I edit on github directly 2013-04-05 12:46:08 -06:00
Thomas S Hatch
1af88122ed Add code_block decs 2013-04-05 12:45:12 -06:00
Thomas S Hatch
5e8ec2c9a7 Add indent style stuff 2013-04-05 12:43:00 -06:00
Tim Hollinger
f13aedfc2b Improved readability, small grammar changes
swapped 'a' for 'an' where appropriate, fixed gramatical errors,
corrected verb agreement
2013-04-03 18:29:05 -06:00
Thomas S Hatch
73a954b6a2 Merge pull request #4289 from grischa/postgres_default_db
renamed postgres.db to postgres.maintenance_db, runas postgres on localhost only
2013-04-01 10:12:09 -07:00
David Boucha
20f1608a41 Merge pull request #4333 from dlindquist/develop
Fix typo: s/mimion/minion/
2013-03-31 12:32:36 -07:00
David Lindquist
009d2354fe Fix typo: s/mimion/minion/ 2013-03-31 12:27:09 -07:00
David Boucha
bbf5cc7f46 Add a needed extra space so it works on cli 2013-03-31 13:21:29 -06:00
Seth House
d18086af40 Tabs -> spaces 2013-03-29 13:20:22 -06:00
Seth House
ae5a4fec4f Fixed broken links at docs footer 2013-03-29 13:19:50 -06:00
Seth House
7dad3f8c4d Fixed uppercase on code-block directives 2013-03-29 13:04:09 -06:00
Seth House
3c626f2bfd Tweak to force headings (only) to appear in custom font 2013-03-29 12:58:25 -06:00
David Boucha
935d7a4eb3 Merge pull request #4318 from tlk2126/ext_pillar_documentation
Ext pillar documentation
2013-03-29 11:34:07 -07:00
Thomas Kula
5c54783cf9 Change the documentation for how ext_pillar is called
Make it clear that the first argument passed is ``pillar``. Also
explain why it makes more sense to return a dictionary of just
the pillar values a particular ext_pillar module is changing or
adding, rather than returning the entire ``pillar`` dictionary.

Note: it isn't documented anywhere that you can use earlier pillar
dictionary values in an external pillar, although that is what the
code does.
2013-03-29 14:28:49 -04:00
Seth House
576c376fd9 Added fileserver and virt runner module docs 2013-03-29 12:25:38 -06:00
Seth House
79b35fe174 Added carbon and sentry returner module docs 2013-03-29 12:25:37 -06:00
Seth House
e7bfefd143 Added libvirt pillar module docs 2013-03-29 12:25:37 -06:00
Seth House
874301d62f Added no_out, no_return, virt_query outputter module docs 2013-03-29 12:25:37 -06:00
Seth House
4e783da4f5 Added a bunch of new execution modules to the docs 2013-03-29 12:25:37 -06:00
Seth House
ffb9bc557f Added disk, npm state module docs 2013-03-29 12:25:37 -06:00
Seth House
c50433556b Removed Nexa font from non-heading text
Too thin; made reading difficult.
2013-03-29 12:25:37 -06:00
Thomas Kula
0ae59dd809 Add documentation on writing external pillars
Explain how an ext_pillar module works, the conventions for how
and when things are called, and what to return.

The explanation of what pre-existing data is passed to
ext_pillar( pillar, ... ) is based on the current code --- I'm not
sure if the current code is a guarantee that it will happen this
way in the future.
2013-03-29 14:18:43 -04:00
David Boucha
fd90f534eb Merge pull request #4304 from JustinCarmony/docs-watch-in-plug
Adding a reference to watch_in on the highstate reference
2013-03-27 20:49:25 -07:00
Justin Carmony
1a333692ac Adding a reference to watch_in on the highstate reference 2013-03-27 21:44:57 -06:00
Grischa Meyer
54f7055a38 renamed postgres.db to postgres.maintenance_db and all postgres module function arguments from db to maintenance_db
made default maintenance_db "postgres" and also made default postgres/psql runas local-server only
2013-03-27 11:03:56 +11:00
Jeff Schroeder
86e7900c29 Adding tomcat state documentation
Fixes #4256
2013-03-26 00:06:12 -05:00
Matthew Williams
8c0a32f335 fix docstrings for cobbler pillar and tops modules 2013-03-25 09:57:26 -07:00
Matthew Williams
ed7b155ddf add docs for new pillar and tops modules
fix inconsistency in modules/service.py docs
2013-03-25 09:42:52 -07:00
David Boucha
12ed1ab9bf Add links to 0.14.0 Salt Windows Installers 2013-03-24 22:37:57 -06:00
Erik Johnson
5b4df95b2b Added notes on installing psutil via pip
Python header files are required, and may not be installed depending on
your distro. Added a paragraph mentioning this.
2013-03-24 11:51:51 -05:00
Thomas S Hatch
4240e55b55 Add --async to the salt man page 2013-03-23 15:49:00 -06:00
Cory Wright
9aed1fe9cf add a mention of the include_empty option to file.recurse 2013-03-22 14:17:08 -04:00
Zoran Simic
b6d361b9d1 Merge branch 'develop' of https://github.com/saltstack/salt into develop 2013-03-21 23:08:38 -07:00
Zoran Simic
98b25c7f78 Fixed formatting in doc/topics/tests/index.rst 2013-03-21 23:07:41 -07:00
Thomas S Hatch
79848bc219 Start on 0.14.0 release notes 2013-03-21 15:23:05 -06:00
Thomas S Hatch
1f0d9d7dab Add libvirt docs to the doc index 2013-03-21 15:22:46 -06:00
Thomas S Hatch
8c3212faba Add libvirt to the index 2013-03-21 15:22:32 -06:00
Thomas S Hatch
4d96f24ebc Merge pull request #4186 from zsimic/develop
Fixed formatting in doc/topics/tests/index.rst
2013-03-21 07:04:02 -07:00
Zoran Simic
0508691e64 Fixed formatting in doc/topics/tests/index.rst 2013-03-21 00:07:42 -07:00
Thomas S Hatch
dd3598eafe Minor edits from #4184
@h3, thanks for the docs update, we greatly appreciate it! I just
changed the tense (we try to keep the docs third person - I know,
it still needs work). Keep it comming!
2013-03-20 22:15:42 -06:00
Thomas S Hatch
6cce655f84 Merge pull request #4184 from h3/patch-1
Update ubuntu documentation
2013-03-20 21:13:03 -07:00
Maxime Haineault
7f1294f932 Update ubuntu documentation
add-apt-repository is not always present by default on Ubuntu systems. Updated the installation doc accordingly.
2013-03-20 23:23:55 -03:00
Erik Johnson
57024a8461 Rename pkg.available_version to pkg.latest_version
See https://github.com/saltstack/salt/issues/4163#issuecomment-15211619

All refs have been updated, and each pkg provider now has
available_version as a function reference pointing to latest_version.

Sphinx docs also updated so that the available_version function
reference is hidden in the docs.
2013-03-20 21:09:15 -05:00
Sean Channel
4ab4ff4021 fix column alignment 2013-03-20 17:54:39 -07:00
Thomas S Hatch
6cac81fe80 Merge pull request #4182 from zsimic/develop
Making tests runnable on OSX
2013-03-20 16:26:22 -07:00
Zoran Simic
6d52cab067 Making tests runnable on OSX 2013-03-20 16:13:22 -07:00
Thomas Jackson
98a969b45e Add minion data to the compound matcher 2013-03-20 12:56:38 -07:00
David Boucha
8318c698b1 Update Windows installer links 2013-03-19 19:50:38 -06:00
Seth House
a4aec32af3 Replaced old sysmod runner docs with doc runner docs 2013-03-19 15:10:11 -06:00
Thomas S Hatch
fa2ce59539 Merge pull request #4154 from terminalmage/issue4109-2
Allow pillar.items to also return pillar data
2013-03-18 23:09:31 -07:00
Gary Wilson Jr
bd499e5640 Fixed several minor misspellings and acronym capitalizations. 2013-03-18 16:42:57 -05:00
Gary Wilson Jr
8c39c1743a Added a couple missing language specifiers for the code-block directive and switched a couple 'yaml' specifications to 'jinja' to get proper highlighting. 2013-03-18 16:42:56 -05:00
Gary Wilson Jr
3850e189e5 Corrected walkthrough path in doc reference. 2013-03-18 16:42:56 -05:00
Gary Wilson Jr
cc72ebb1fb Fixed :doc: uses in the docs that were not rendering due to an extra space. 2013-03-18 16:42:56 -05:00
Thomas S Hatch
b03ca985c2 update the pillar walkthrough with the new get functions 2013-03-18 13:38:47 -06:00
Erik Johnson
100053ad7e Allow pillar.items to also return pillar data 2013-03-17 01:55:32 -05:00
Thomas S Hatch
d54683b02b Merge pull request #4124 from jer/patch-1
Updating the output format for ping calls
2013-03-16 21:50:08 -07:00
pengyao
0176cde512 modify content error, "vm.swappines" to "vm.swappiness" 2013-03-17 10:45:15 +08:00
Jeremiah Wuenschel
b58ea7aaed Updating the output format for ping calls
A default installation no longer has JSON-style output
2013-03-16 16:30:57 -07:00
Thomas S Hatch
a91a12cbfb doc fix for some links 2013-03-14 10:18:26 -06:00
Thomas S Hatch
e3cb131d8a Add pillar walkthrough 2013-03-13 23:45:44 -06:00
Thomas S Hatch
7ad7a28acc Add gitfs tutorial 2013-03-13 23:45:44 -06:00
Thomas S Hatch
d6ad39fd89 Add refs to walkthrough to new tutorials 2013-03-13 23:45:43 -06:00
Thomas S Hatch
8f4216b025 Add note about pillar walkthrough to starting states 2013-03-13 23:45:43 -06:00
Thomas S Hatch
430cd2788b Add redirect to pillar walkthrough at the end 2013-03-13 23:45:43 -06:00
David Boucha
12374d8c78 Add link to 64bit Windows installer 2013-03-13 14:52:49 -06:00
David Boucha
fd51b34aae Add link to 32bit Salt Windows installer 2013-03-13 11:04:41 -06:00
Pete Emerson
86318d3da6 Added puppet pillar and documentation 2013-03-12 17:41:40 +00:00
Grischa Meyer
bf4aaae3db Postgres modules now respects the pillar setting postgres.pass, as promised in the documentation
Needed to rename the password for newly created or changed roles to rolepassword.
2013-03-11 23:22:32 +11:00
Erik Johnson
c54b96becb Update package provider writing guidelines
Included a paragraph about available_version that reflects the changes
made to implement #3687.
2013-03-10 10:16:34 -05:00
Vijay Halaharvi
3654ac94fe config is not available in __opts__
Using this example with salt-run throws a KeyError for 'config', use 'conf_file' instead.
2013-03-08 20:23:56 -06:00
Jakub Vysoky
2cf4e35994 simple typo found in docs 2013-03-08 11:42:54 +01:00
Pete Emerson
4273fd5831 Fix typo in grains.rst 2013-03-07 14:27:22 -08:00
Pete Emerson
88d25814d0 Listing grains and grain data 2013-03-07 13:32:46 -08:00
Valentin Bud
7ac3e35a6c Update walkthrough.rst 2013-03-07 20:01:31 +02:00
Thomas S Hatch
6cf175e11c Merge pull request #3978 from valentinbud/develop
Update walkthrough.rst
2013-03-07 09:36:02 -08:00
Valentin Bud
09f39c4859 Update walkthrough.rst 2013-03-07 19:31:41 +02:00
Thomas S Hatch
3ccd3bcc31 Merge pull request #3977 from valentinbud/develop
Update walkthrough.rst
2013-03-07 09:24:11 -08:00
Valentin Bud
a487e884bb Update walkthrough.rst 2013-03-07 18:58:21 +02:00
Thomas S Hatch
d7b154a6a4 Clean up rst formatting 2013-03-07 09:54:18 -07:00
Valentin Bud
608ee7c809 Update debian.rst 2013-03-07 17:18:43 +02:00
Thomas S Hatch
d285005b10 Merge pull request #3933 from dcolish/correct-installation-index-doc
Add M2Crypto dependency back in to the installation requirements
2013-03-04 21:07:50 -08:00
Dan Colish
2247c300ab Add M2Crypto dependency back in to the installation requirements
* It was removed 3867ffb3ef but not added
  back when the patch was reverted.
2013-03-04 19:57:02 -08:00
Seth House
e1c52914f1 Switched hard-coded URL to use the :blob: ref 2013-03-04 14:38:36 -07:00
Seth House
50c2acf07e Added explicit reference to the Python API docs 2013-03-04 14:32:31 -07:00
Jack Kuan
deee61c51a Fix a regression in the stateconf renderer and updated docs. 2013-03-01 09:35:45 -05:00
Seth House
e94a47ed6c Add html_default_sidebars to context dict
Omitted from f300e75.
2013-02-28 10:45:03 -07:00
Seth House
f300e75afe Restored html_default_sidebars setting; added JS TOC to modules sidebar
Using JavaScript to generate a local table of contents for the modules
is less than ideal but this isn't easily accomplished with autosummary
(see 87c1000) and we badly need this.
2013-02-28 10:14:14 -07:00
Colton Myers
2a831e1565 Merge pull request #3875 from mschartman/patch-1
Update doc/topics/tutorials/walkthrough.rst
2013-02-27 18:52:47 -08:00
Seth House
40631dc344 Blacklist old jQuery version that ships with Sphinx 2013-02-27 18:40:54 -07:00
Matt Schartman
0fe10d4e55 Update doc/topics/tutorials/walkthrough.rst
Changed 'coppied' to 'copied'
2013-02-27 15:54:58 -08:00
Nelson Chen
9311ef4c1c Fix for minor typo in walkthrough
s/sill/still/
2013-02-27 14:12:29 -08:00
John Albietz
cb5a69150f static doesn't take arguments. 2013-02-27 13:07:39 -08:00
John Albietz
a81e0af395 execution sp 2013-02-27 01:16:53 -08:00
David Boucha
8489f1484f Remove unneeded images for the docs 2013-02-26 15:55:26 -07:00
Seth House
19222e3e6c Switch to Sphinx-default sidebars 2013-02-26 15:18:31 -07:00
Seth House
57902fa267 Updated docs with new design 2013-02-26 12:22:03 -07:00
Seth House
259c8848b6 Restored saltstack theme 2013-02-26 12:22:03 -07:00
Thomas S Hatch
f6df098a42 Merge pull request #3850 from seanchannel/develop
Ubuntu firewall rules are already included
2013-02-26 10:26:46 -08:00
Sean Channel
07d37bfab0 Ubuntu firewall rules are already included 2013-02-26 10:19:46 -08:00
Jack Kuan
28f2569879 Fix a typo and try to squeeze in pydsl along the py renderer to give it more publicity! ;) 2013-02-26 13:16:02 -05:00
Daniel Hepper
59635e81ac Fixed typo in Walkthrough 2013-02-26 09:50:03 +01:00
Thomas S Hatch
70aaadd147 Reformat the docs main page
This moves the docs towards being better suited for newcomers and
directs people to needed reference materials
2013-02-26 00:37:43 -07:00
kennyballou
659024ab40 Remove configuration files section (Arch Linux)
This is already being done, maybe since as far back as
0d7732930a
2013-02-25 22:41:31 -07:00
Thomas S Hatch
6c94d8136f Fix more of the walkthrough and add a few more pieces 2013-02-25 19:15:50 -07:00
Thomas S Hatch
88902aca33 minor fixes to walkthrough 2013-02-25 18:32:32 -07:00
Thomas S Hatch
91dc74cec7 Finish first draft of the walkthrough 2013-02-25 18:15:39 -07:00
Thomas S Hatch
ff88e0b0d1 More on the walkthhrough 2013-02-25 14:37:00 -07:00
David Boucha
25ad4ffef8 Fix Windows Installer download location 2013-02-24 20:27:28 -07:00
Thomas S Hatch
f25cb3e46b Add some good functions to walkthrough 2013-02-24 19:31:16 -07:00
Thomas S Hatch
d1aa2a2286 Add notes to walkthrough 2013-02-23 23:01:19 -07:00
Thomas S Hatch
3de49b6ab1 Merge pull request #3824 from archtaku/docs
Add notes on true/false, yes/no, on/off
2013-02-23 21:43:58 -08:00
Thomas S Hatch
0490ca7852 Start work on the official walkthrough 2013-02-22 14:03:43 -07:00
Erik Johnson
eb1f3a50ca Add notes on true/false, yes/no, on/off 2013-02-22 12:09:32 -08:00
Thomas S Hatch
11b7591dd0 Merge pull request #3816 from bclermont/develop
Fix master reference settings documentation
2013-02-21 21:37:04 -08:00
Bruno Clermont
390c5898c4 we're talking about master configuration here.
fix copy-paste from doc/ref/configurations/minion.rst.
2013-02-21 16:15:27 +08:00
Thomas S Hatch
a394170354 Merge pull request #3782 from ydavid365/patch-10
added salt_token filename
2013-02-20 22:53:51 -08:00
John Albietz
4c780b0525 added salt_token filename 2013-02-18 14:19:57 -08:00
John Albietz
2e9cdc8f7e typo fix. added example of unrestricted access. 2013-02-18 14:13:02 -08:00
Thomas S Hatch
fff07a3fc0 Merge pull request #3768 from ydavid365/grains-state-doc
added grains state module to docs
2013-02-18 09:11:02 -08:00
Thomas S Hatch
5f02401e1e Merge pull request #3766 from ydavid365/module-sp
module sp
2013-02-18 09:09:52 -08:00
HVN
c66201898c fixbug on extend example 2013-02-18 15:47:00 +07:00
ydavid365
bc756c69be added grains state module to docs 2013-02-18 00:11:51 -08:00
ydavid365
18bec175ad module sp 2013-02-17 23:26:28 -08:00
David Boucha
9aae00b28b Better list for the Windows Installers 2013-02-17 21:05:31 -07:00
David Boucha
27038e5792 Add links to 0.13.1 installers 2013-02-17 20:34:27 -07:00
David Boucha
656432b6b8 Clarify msiexec docs a little 2013-02-14 19:39:12 -07:00
David Boucha
d1ed6b0f58 Add docs for msiexec 2013-02-14 19:36:24 -07:00
Erik Johnson
5eef8217d6 Add notes on requisite matching 2013-02-13 21:34:21 -06:00
David Boucha
e51e6df47d Add link to writing State docs 2013-02-13 11:34:06 -07:00
Erik Johnson
b38a942660 Add version spec info to 0.13.0 release notes 2013-02-12 16:20:53 -06:00
Seth House
47fa18c6e2 Fixed spelling error in release notes
Thanks @SEJeff
2013-02-12 14:39:26 -07:00
Thomas S Hatch
adf6018a68 update man pages for 0.13.0 2013-02-12 12:02:51 -07:00
Thomas S Hatch
96071d8b0d Remove cluser docs 2013-02-12 11:41:01 -07:00