Commit Graph

22 Commits

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