valitydev/salt
14
0
Fork 0
mirror of https://github.com/valitydev/salt.git synced 2024-11-07 00:55:19 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity
61,338 Commits 24 Branches 182 Tags 341 MiB
a09aa18036
Commit Graph

227 Commits

Author SHA1 Message Date
Jens Rantil
4666b29174 doc(bootstrap-dev): make long socket path warning a note 
It doesn't really feel like part of the text body.
 2015-01-07 22:25:24 +01:00
Jens Rantil
fee650b4b0 one less command to get started when bootstrapping 2015-01-07 21:41:19 +01:00
Justin Findlay
ad33589fac move requirements files into requirements dir 2014-12-27 17:29:03 -07:00
Colton Myers
dc778a8e5e Merge branch '2014.7' into develop 
Conflicts:
	salt/client/ssh/__init__.py
	salt/states/boto_secgroup.py
 2014-12-23 10:57:26 -07:00
Seth House
a33ae0655f Switch the :formula: extlink to :formula_url: 
The addition of the Salt domain conflicted with this role. Better to
rename this one to be more explicit and to save that real-estate for
future use.
 2014-12-19 14:34:57 -07:00
Colton Myers
fc16bd16c0 Merge branch '2014.7' into merge-forward 
Conflicts:
	doc/faq.rst
	doc/ref/states/compiler_ordering.rst
	doc/topics/best_practices.rst
	doc/topics/development/conventions/formulas.rst
	salt/config.py
	salt/modules/state.py
	salt/states/mount.py
	salt/utils/event.py
	tests/unit/utils/process_test.py
 2014-12-16 14:45:25 -07:00
Seth House
51fa87c446 Change all state examples to use short-dec format for consistency 
Closes #12419.

The command used to search the docs for state examples is below. This
generates a file in Vim's quickfix format that can be loaded with the -q
flag.

find . -type f \( -name '*.rst' -o -name '*.py' \) -print0
    | xargs -0 -P10 -n1 awk '
        BEGIN { RS=""; FS="\n" }
        { linenr = linect; linect += (NF + 1) }
        /^\s+[a-zA-Z0-9'\''_-]+:\n\s+[a-zA-Z0-9'\''_-]+:\n\s+- / {
            print FILENAME "|" linenr + 2 "|", $1
        }
    ' > ./salt-states.quickfix
 2014-12-12 23:36:40 -07:00
Seth House
c0567bab0f Updated Formula Best Practices doc with several recommendations 2014-12-12 17:43:00 -07:00
Thomas Jackson
fb7e5630d8 Comma cleanup 2014-12-12 11:39:40 -08:00
Thomas S Hatch
e094b0136f Merge pull request #18902 from jacksontj/develop 
More grammar/style cleanup
 2014-12-12 09:40:55 -07:00
Joseph Hall
7099c02a53 Add serial commas to the style guide 2014-12-12 03:30:11 -07:00
Thomas Jackson
498a612078 Whitespace cleanup 
Conflicts:
	doc/topics/cloud/linode.rst
	doc/topics/cloud/misc.rst
	doc/topics/cloud/parallels.rst
	doc/topics/cloud/proxmox.rst

Conflicts:
	doc/topics/development/architecture.rst
	doc/topics/development/translating.rst
 2014-12-11 07:53:19 -08:00
Nitin Madhok
d2685b8fa2 Fixing sphinx errors 2014-12-08 11:18:12 -05:00
Seth House
75ef72b7fb Merge pull request #18523 from saltstack/revert-18148-six_docs_build 
Revert "[don't merge!!] Add six dependency notice to building docs intru...
 2014-11-26 16:19:42 -07:00
T.J. Yang
a6535cf37d makefile update at Wed Nov 26 16:21:18 CST 2014 2014-11-26 16:21:18 -06:00
Nicole Thomas
e1157d13be Revert "[don't merge!!] Add six dependency notice to building docs intructions" 2014-11-26 12:23:13 -07:00
Colton Myers
dc43840cee Merge branch '2014.7' into merge-forward 
Conflicts:
	salt/modules/glusterfs.py
	salt/modules/macports.py
	salt/modules/makeconf.py
	salt/modules/mdadm.py
	salt/modules/smartos_vmadm.py
	salt/modules/zypper.py
	salt/utils/event.py
	tests/integration/netapi/rest_tornado/test_app.py
	tests/unit/netapi/rest_tornado/test_handlers.py
 2014-11-21 12:05:32 -07:00
Seth House
898f1a70c3 Fix missing space after colon in architecture doc 
Fixes #18134
 2014-11-20 12:30:33 -06:00
Nitin Madhok
5d8ae4e32f Fixing sphinx violations and errors 2014-11-18 02:53:40 -05:00
rallytime
e2c5ae3390 Add six dep notice to building docs instructions in documentation doc 2014-11-17 13:18:38 -07:00
rallytime
4660a04d30 Add six dep to build the docs in hacking doc 2014-11-17 13:17:37 -07:00
Sławek Ehlert
9e19772bff base arg should be a key (string) of the given dict 2014-11-16 00:05:25 +01:00
Thomas S Hatch
6d38d2db62 Merge branch '2014.7' into develop 
Conflicts:
	salt/utils/__init__.py
 2014-11-14 14:38:55 -07:00
Justin Findlay
9158661205 expand unittest docs: formal style, more examples 2014-11-12 16:55:50 -07:00
Justin Findlay
217217f624 wrap unittest doc at 80 chars 2014-11-12 15:59:35 -07:00
Thayne Harbaugh
e4488a3956 Add yaml_encode() jinja filter 
* Add documentation for yaml_encode()
  * Mention yaml_encode() in formulas documentation
  * Add unit tests for yaml_encode()
  * Improve unit tests and documentation for related yaml_dquote()
 2014-11-07 19:12:58 -07:00
Thayne Harbaugh
11c0999c66 Add a note to formulas documentation describing yaml_dquote filter. 2014-11-04 12:54:16 -07:00
Colton Myers
f625c21d77 Merge branch '2014.7' into mergeforward 
Conflicts:
	salt/cloud/clouds/ec2.py
	salt/daemons/flo/worker.flo
	salt/master.py
	salt/minion.py
	salt/modules/lxc.py
	salt/states/win_update.py
	salt/states/zk_concurrency.py
 2014-10-30 17:42:36 -06:00
Thomas Jackson
9f7dac0674 Spelling fixes for docs 2014-10-28 08:12:27 -07:00
Thayne Harbaugh
65e477dd67 Improve filter_by() base argument: 
* Change filter_by() base argument to a key in lookup_dict rather
    than a dictionary.  This allows more compact usage and more
    readable use of base values/defaults in the lookup_dict.

  * Change/improve function-local documentation for lookup_dict().

  * Add specific use-case of "base" argument for lookup_dict() in the
    formulas documentation.

  * Expand filter_by() unit testing to validate use of base argument.

  * Add unit test for salt.utils.dictupdate.update() to provide
    complete depth-of-testing of filter_by() which uses
    dictupdate.update().
 2014-10-24 11:13:47 -06:00
Steve Weber
54b9aedbf7 ipython log to look for 2014-10-06 12:54:36 -04:00
Thomas S Hatch
3e204c16f3 Merge branch '2014.7' into develop 2014-09-29 20:07:01 -06:00
rallytime
0b99acc381 Add info about running unittests w/o integration test daemons 2014-09-28 10:52:37 -06:00
Erik Johnson
18456b6bbf Spelling and formatting fixes 2014-09-27 12:14:12 -05:00
Steve Weber
ca2841a7ec Update modular_systems.rst 2014-09-27 12:22:47 -04:00
Steve Weber
b6d2f6966a using ipython 
small fix
 2014-09-27 12:18:46 -04:00
Steve Weber
d444d833ce add some help using an interactive cli debugger 
when hacking some tricky code i find using ipython productive.
 2014-09-27 12:10:22 -04:00
Nitin Madhok
6acc5d5198 More 2014-09-16 10:01:50 -04:00
Nitin Madhok
72f3bf8c53 More doc fixes 2014-09-16 09:59:01 -04:00
Colton Myers
8d0bf0ee95 Merge branch '2014.7' into develop 
Conflicts:
	salt/states/pip_state.py
 2014-09-15 11:49:04 -06:00
Mike Place
f7d89816b1 Job flow doc 2014-09-12 11:01:30 -06:00
Nitin Madhok
773ccadeff Update formulas.rst code blocks 2014-09-05 16:34:24 -04:00
Colton Myers
36ef47e7a2 Merge branch '2014.7' into develop 
Conflicts:
	conf/minion
	salt/modules/mine.py
 2014-09-02 10:43:31 -06:00
Seth House
47efe38949 Added instructions on how to back-port fixes to release branches 2014-08-27 20:17:12 -06:00
Kamal Nasser
c613c08869 Replace all occurrences of "Digital Ocean" with "DigitalOcean" 2014-08-25 13:42:01 -06:00
Colton Myers
ad89a752f8 Merge branch '2014.7' into develop 
Conflicts:
	salt/cloud/__init__.py
	salt/utils/cloud.py
 2014-08-25 13:29:29 -06:00
Mike Place
0d03e31fb7 Add info about pillar refresh. 2014-08-25 10:56:55 -06:00
wackycaptain
1032754af9 Fix broken links in contributing documentation. 2014-08-16 23:27:58 +02:00
Nitin Madhok
f99dac462b Update formulas.rst 
Fixes https://github.com/saltstack/salt/issues/14900
 2014-08-12 13:18:48 -04:00
Sylvain Bellemare
9f6ecc4874 Removed duplicate occurrences of the word "the" 2014-08-11 16:05:29 +02:00
Kamal Nasser
825bb191bf Replace all occurrences of "Digital Ocean" with "DigitalOcean" 2014-08-08 22:16:37 +03:00
Seth House
8a60ce5351 Merge remote-tracking branch 'upstream/2014.7' into develop 
Conflicts:
	doc/topics/development/conventions/formulas.rst
 2014-08-07 15:51:49 -04:00
Seth House
b656adef77 Fleshed out Formula Parameterization section 2014-08-06 10:51:46 -04:00
Seth House
d3d8c08ddd Removed the redundant platform agnostic Formula section 2014-08-06 10:45:16 -04:00
Seth House
8758b02445 Fleshed out the recommendations for writing reusable formulas 2014-08-06 10:45:16 -04:00
Seth House
b7eb6a5c09 Moved the Formula repository structure docs to the bottom 
We should describe best practices for writing formulas first.
 2014-08-06 10:45:15 -04:00
Seth House
f741aee4a4 Improve and clarify the Formula docs on using formulas from non-formulas 2014-08-06 10:39:48 -04:00
Seth House
3f7118dd8b Improved the Formula installation docs with examples 2014-08-06 10:39:47 -04:00
Seth House
f819a1e85c Improved the simple Formula usage example at the top 2014-08-06 10:39:47 -04:00
Seth House
20dd4b42de Updated the Formula README recommendation 2014-08-06 10:39:47 -04:00
Seth House
1815e24fe9 Improve and shorten the Formula lookup table recommendation 2014-08-06 10:39:41 -04:00
Seth House
b46d087966 Moved the Formula Conventions CHANGELOG section down next to Versioning 
This section is less important for new users than the mapfile and sls
recommendation sections.
 2014-08-06 10:34:42 -04:00
Seth House
93da920147 Removed 0.17 requirement note from formula docs 
0.17 is no longer a supported release.
 2014-08-06 10:34:41 -04:00
Nitin Madhok
4f9349381e Fixing a broken link and formatting code block 2014-07-29 12:03:49 -04:00
Seth House
94d8fc966e Updated the contributor documentation with the new branching workflow 2014-07-21 20:19:33 -06:00
rallytime
a8cd830d52 Change "Helium" to 2014.7.0 in affected docs 2014-07-15 16:53:29 -06:00
Seth House
39a0b4dfc3 Fix bad global rST links for the mailing lists 2014-07-14 15:04:50 -06:00
Erik Johnson
2849950bce Docs cleanup 
Fixes double-colons by making them code-block directives, so they do not
erroneously show up as "PYTHON" blocks. Also corrects a few instances of
2nd person pronoun usage.
 2014-07-13 11:02:33 -05:00
Forrest Alvarez
208832f9ab Fixed some spacing issues in the contributing docs. 2014-07-10 12:14:37 -07:00
Forrest Alvarez
846bc97bd2 Updated the contributing guide with a link to the documentation contribution docs. 2014-07-10 12:11:11 -07:00
Erik Johnson
67df3a9db4 Fix code-block 
This is another fix to make the docs more accurate with the new sphinx
theme.
 2014-07-05 22:51:05 -05:00
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