Commit Graph

206 Commits

Author SHA1 Message Date
Mike Place
915570f045 Formalize a policy for initializing dictionaries. 2014-06-24 18:35:13 -06:00
Colton Myers
df7ef6f504 Fix typo 2014-06-19 16:19:20 -06:00
Colton Myers
a41b4107ea Add some notes about cherry-picking 2014-06-19 16:17:46 -06:00
rallytime
cd91d4c9cc Added expensiveTest documentation to cloud testing docs 2014-06-11 11:17:27 -06:00
rallytime
ce43e04769 change cloud docs to reflect runtest changes 2014-06-10 10:32:38 -06:00
rallytime
35155cc587 Documentation for cloud provider integration tests 2014-06-09 14:49:50 -06:00
rallytime
153e71c76b Minor changes to integration test docs 2014-05-29 08:56:58 -06:00
rallytime
24d41b0212 More testing documentation improvements 2014-05-28 13:29:20 -06:00
rallytime
6610e08ebf Improvements to general and integration testing docs 2014-05-27 15:59:30 -06:00
Seth House
8a3cce4620 Added documentation on how to write Salt documentation
Closes #12792
2014-05-20 23:50:52 -06:00
Colton Myers
70ff1c5878 Don't recommend adding formulas to gitfs directly! 2014-05-01 14:06:34 -06:00
Chris Rebert
8af229253f more copyediting 2014-04-30 13:55:48 -07:00
Erik Johnson
a76747f780 Split up contributing/development docs
This page has become massive and merits being split into two pages.
Also, it affords the opportunity of getting rid of an ambiguous header
name that causes confusion.

Fixes #10830.
2014-04-22 17:25:58 -05:00
Mike Place
4893b046cb A note about cherry-picking 2014-04-09 09:26:28 -06:00
Chris Rebert
746e88bf4b improve formatting in Linting section of dev docs 2014-04-08 15:18:10 -07:00
Thomas S Hatch
fa9ed5df7e Merge pull request #11431 from hulu/decript
fix apparent 'decript' typos in raet stuff
2014-03-22 00:36:59 -06:00
Chris Rebert
5a84963063 fix apparent 'decript' typos 2014-03-21 16:10:56 -07:00
Chris Rebert
e0343c9fa7 fix various typos in raet code comments+docstrings 2014-03-21 16:07:28 -07:00
Pedro Algarvio
6509176357 Provide line length style guides 2014-03-21 20:57:48 +00:00
Thomas S Hatch
7031e4fa5c A little more clarification 2014-03-20 16:44:54 -06:00
Thomas S Hatch
370d9718e8 Clarify modification of defaults in packages 2014-03-20 16:19:49 -06:00
Tim O'Guin
fffe282c38 added django-salted project to list of community projects in salt_projects.rst 2014-03-13 13:47:12 -05:00
Joseph Hall
8f8577e336 Merge pull request #11069 from s0undt3ch/hotfix/minor
Minor corrections
2014-03-08 05:35:33 -07:00
Pedro Algarvio
e26d7f1db9 Update doc to reflect proper __virtual__ usage. 2014-03-08 11:03:07 +00:00
Erik Johnson
645ac140c0 Add information on yum-utils requirement for yum pkg mgmt 2014-03-05 12:09:07 -06:00
Seth House
14c225989e Added note to also upload the sdist to GitHub releases 2014-03-04 14:39:32 -08:00
Thomas S Hatch
83bca6d429 Merge pull request #10854 from pengyao/ext_pillar
example should use escape character
2014-02-28 08:11:47 -07:00
pengyao
721ca2bf21 example should use escape character
echo command will clear the quotation mark, should use escape character("\")
2014-02-28 15:19:37 +08:00
Mike Place
2637fc689f Docs build cleanly! Yay! 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
David Lindquist
9c91539de7 Replace mentions of 0.18.0 with 2014.1.0 2014-02-14 17:01:57 -08:00
Thomas L. Kula
a28414b1e4 Update ext_pillar documentation for new ext_pillar signature
With issue #5911 the signature of ext_pillar was changed to
make the ID of the minion be the first argument. Update the
documentation to reflext that.
2013-11-12 17:38:40 -05:00
Erik Johnson
fc1691ffee Fix refs to old pkg_resource.pack_pkgs 2013-10-25 12:47:45 -05:00
Thomas S Hatch
8daa55f7d7 Add more dunder dict docs per @cachedout
There are still a few esoterics to get in from some of the backend
module systems, but these are the big ones
2013-10-01 16:10:22 -06:00
Pedro Algarvio
931e0c4b05 Minor updates to include the external logging handler documentation. 2013-08-30 23:14:40 +01:00
Chris Rebert
193bd841ac deprecations.rst: fix grammar: it's => its 2013-08-21 13:42:39 -07: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
eb339ef1fa Replace references to 0.16.1 with 0.16.2 2013-08-01 20:10:45 -05:00
Pedro Algarvio
09671fe759 Moved deprecation documentation to it's own document under topics/development 2013-07-20 19:18:55 +01:00
Tomas Kral
744549da55 fix broken links on 'Modular System' page 2013-07-09 19:10:12 +02:00
Sebastian Vetter
84ca6fd8f6 Fix folder name for external pillars in docs 2013-06-30 19:01:20 +10:00
Colton Myers
59a549c662 Add example for ext_pillar in docs, Fix #5653 2013-06-20 15:32:56 -06:00
Colton Myers
7b84a2fe8d Remove trailing whitespace 2013-06-20 15:29:59 -06:00
Chris Rebert
daf11a081f copyedit modular_systems.rst
spelling/typos/homophones
run-on sentences
commas
grammar
2013-05-29 16:52:12 -07:00
Thomas S Hatch
de32f33ad1 Add modulear_systems doc 2013-05-29 21:26:55 +00:00
Seth House
7dad3f8c4d Fixed uppercase on code-block directives 2013-03-29 13:04:09 -06: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
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
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
Gary Wilson Jr
bd499e5640 Fixed several minor misspellings and acronym capitalizations. 2013-03-18 16:42:57 -05: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
Joseph Hall
28c5d4a306 Adding documentation for pkg (repos) and lowpkg 2013-02-04 12:18:12 -07:00
Erik Johnson
16f83aced9 add package provider documentation 2013-02-02 21:34:26 -06:00
Seth House
567a1edac7 Misc rST fixes 2013-01-23 23:40:24 -07:00
David Boucha
41f53e12d6 Add first draft of developer docs.
Add directory for future developer docs.

Add first doc on the "dunder dictionaries" on the "__context__" dict
2013-01-10 15:38:26 -07:00