Commit Graph

282 Commits

Author SHA1 Message Date
Ryan Lewis
91acf739fe Added docs for gotchas when developing on gentoo 2015-07-16 08:19:10 +12:00
Steven Braverman
8416299cc1 Updates documentation for external_pillar - Fixes Bash Example 2015-07-14 14:26:00 -07:00
Steven Braverman
09c0c9c64e Updates documentation for external_pillar - example on how to use 2015-07-13 11:56:28 -07:00
Colton Myers
99fc7ecb4b Merge remote-tracking branch 'upstream/2015.5' into merge-forward-develop
Conflicts:
    doc/man/salt-call.1
    doc/man/salt-cloud.1
    doc/man/salt-cp.1
    doc/man/salt.7
    salt/cloud/__init__.py
    salt/fileclient.py
    salt/modules/file.py
    salt/modules/gpg.py
2015-06-29 16:49:40 -06:00
Justin Findlay
8575192cc4 revise label and milestone documentation 2015-06-27 16:17:44 -06:00
Justin Findlay
152a9b2a12 fix some malformed doc links and anchors 2015-06-24 16:56:52 -06:00
Mike Place
7dae045b3c Remove overstate documentation 2015-06-12 13:00:08 -06:00
Colton Myers
94d6ef1d17 Merge remote-tracking branch 'upstream/2015.5' into merge-forward-develop
Conflicts:
    doc/ref/modules/all/salt.modules.ipmi.rst
    doc/ref/states/all/salt.states.tls.rst
    doc/topics/cloud/index.rst
    doc/topics/cloud/vsphere.rst
    doc/topics/eauth/index.rst
    salt/cli/batch.py
    salt/modules/cmdmod.py
    salt/modules/ipmi.py
    salt/netapi/rest_cherrypy/app.py
    salt/runners/http.py
    salt/states/boto_elb.py
    salt/states/dockerio.py
    salt/states/linux_acl.py
    salt/states/win_servermanager.py
    salt/wheel/config.py
2015-06-09 11:41:07 -06:00
Jacob Hammons
d45c4ed11f Bug fixes and build errors
Refs #23211
Refs #24268
Refs #24235
Refs #24193
Refs #24172
Refs #19901
Refs #19801
2015-06-05 17:32:35 -06:00
Justin Anderson
a6a1f87cd9 Merge pull request #24380 from rallytime/bp-24357
Backport #24357 to 2015.5
2015-06-04 14:13:51 -06:00
rallytime
bf85772042 Make sure the parameters are in the correct order 2015-06-04 11:39:39 -06:00
rallytime
9f53809cde Add "* Change" label parameters 2015-06-04 11:39:39 -06:00
rallytime
b27a15e774 Remove "workaround" wording 2015-06-04 11:39:39 -06:00
rallytime
9fff35a959 Some small fixes 2015-06-04 11:39:39 -06:00
rallytime
54a7089fd6 Link the new labels doc in contributing and hacking docs 2015-06-04 11:39:39 -06:00
rallytime
375695e696 Add pull request label definitions 2015-06-04 11:39:39 -06:00
rallytime
de945638d3 Add Feature Request label definition 2015-06-04 11:39:39 -06:00
rallytime
684f291bd4 Add issue definition and augment functional areas section 2015-06-04 11:39:39 -06:00
rallytime
2da13dd525 Start a "what are all of these labels for?" doc 2015-06-04 11:39:38 -06:00
zhujinhe
f08c875015 fix invoke issues of Jinja Macros example
1.'php_ini' not defined in /srv/pillar/php.sls, {{ salt.pillar.get('php_ini', {}) | json() }} gets empty value.
2.no section defined, should be 'section_name'.
3.remove empty line.
2015-06-03 16:38:16 -06:00
zhujinhe
15cdd58968 fix invoke issues of Jinja Macros example
1.'php_ini' not defined in /srv/pillar/php.sls, {{ salt.pillar.get('php_ini', {}) | json() }} gets empty value.
2.no section defined, should be 'section_name'.
3.remove empty line.
2015-06-03 12:16:29 +08:00
Jason Thigpen
beff7c7785 Correct usage of import_yaml in formula documentation 2015-05-31 09:43:15 -06:00
Jason Thigpen
37775a5fa6 Correct usage of import_yaml in formula documentation 2015-05-29 17:12:59 -07:00
Colton Myers
c4f5e231fa Merge remote-tracking branch 'upstream/2015.5' into merge-forward-develop2
Conflicts:
    doc/_themes/saltstack2/layout.html
    doc/conf.py
    doc/index.rst
    doc/ref/modules/all/salt.modules.hipchat.rst
    doc/topics/releases/index.rst
    salt/client/ssh/client.py
    salt/cloud/clouds/vsphere.py
    salt/modules/boto_dynamodb.py
    salt/modules/boto_route53.py
    salt/modules/data.py
    salt/modules/http.py
    salt/modules/tls.py
    salt/output/compact.py
    salt/states/boto_elb.py
    salt/states/linux_acl.py
    salt/states/rabbitmq_user.py
    salt/states/win_servermanager.py
    salt/utils/dictupdate.py
    salt/wheel/config.py
2015-05-29 15:10:13 -06:00
Jacob Hammons
0689815d0e Fixes for doc build errors 2015-05-27 11:40:31 -06:00
Colton Myers
60f2e9eefb Merge remote-tracking branch 'upstream/2015.5' into merge-forward-develop
Conflicts:
    doc/topics/development/contributing.rst
    salt/modules/tls.py
2015-05-26 16:38:42 -06:00
Justin Findlay
fa2d411f53 update example release branch in contrib docs 2015-05-25 23:06:39 -06:00
Justin Findlay
a0b76b57b3 clarify git rebase instructions 2015-05-25 23:05:23 -06:00
Justin Findlay
3517e0095f fix contribution docs link typos 2015-05-25 22:55:19 -06:00
Justin Findlay
651629c6a4 backport dev contrib doc updates to 2015.5 2015-05-25 22:54:54 -06:00
Oliver Bestwalter
4ba0f20ef6 fix typos 2015-05-14 01:23:20 +02:00
rallytime
0fe9d05ab0 Make sure the parameters are in the correct order 2015-05-05 14:35:44 -06:00
rallytime
e9491e8991 Add "* Change" label parameters 2015-05-05 14:21:25 -06:00
rallytime
8024acc7ad Remove "workaround" wording 2015-05-05 13:47:34 -06:00
rallytime
ed788a2965 Some small fixes 2015-05-05 13:37:44 -06:00
rallytime
475a32d3aa Link the new labels doc in contributing and hacking docs 2015-05-05 13:23:08 -06:00
rallytime
644201aed8 Add pull request label definitions 2015-05-05 13:11:59 -06:00
rallytime
3c95bd9a6b Add Feature Request label definition 2015-05-04 12:43:34 -06:00
rallytime
1780e2eb8a Add issue definition and augment functional areas section 2015-05-04 11:39:32 -06:00
rallytime
85e9284bac Start a "what are all of these labels for?" doc 2015-05-03 21:11:18 -06:00
Justin Findlay
e586c66917 revise contributing documentation 2015-04-16 10:28:00 -06:00
rallytime
ccfa9f8158 Fix some broken links on the contributing docs
Fixes #22537
2015-04-10 14:06:36 -06:00
Justin Findlay
f50949e209 revise unit test documentation 2015-03-31 00:40:05 -06:00
Justin Findlay
0f631abe58 fix contributing doc errors 2015-03-10 16:04:17 -06:00
Justin Findlay
79255566b9 revise saltstack/salt contrib documentation 2015-02-25 15:05:21 -07:00
Mike Place
970c32ae8e Document the bug reporting procedure 2015-02-18 09:22:28 -07:00
Brandon Weaver
894d8d8c1a Fix typo
Found a minor typo, quick fix.
2015-02-17 13:09:51 -08:00
toppur
cdbaff63b7 Update formulas.rst
There's not keyword named 'base' here, should be 'default'.
2015-02-09 18:24:11 -08:00
rallytime
d724ed3a47 Merge branch '2015.2' into 'develop'
Conflicts:
	salt/cli/batch.py
	salt/cloud/clouds/msazure.py
	tests/integration/netapi/rest_tornado/test_app.py
2015-01-16 11:36:32 -07:00
Colton Myers
d1b201e2bf Merge remote-tracking branch 'upstream/2014.7' into merge-forward-2015.2
Conflicts:
	salt/runners/manage.py
	salt/utils/cloud.py
2015-01-15 16:20:48 -07:00
rallytime
4d5cc90c6a Remove sshpass checks from utils/cloud.py and other references
Fixes #19219
2015-01-14 23:08:00 -07:00
Thomas S Hatch
0529136858 Merge pull request #19510 from JensRantil/sphinx-1.3b2
doc(dev-bootstrap): Sphinx 1.3b2
2015-01-08 09:57:42 -07:00
Jens Rantil
9e92864398 doc(dev-bootstrap): Sphinx 1.3b2
I was getting an error that the current stable version of Sphinx wasn't
new enough. Installing Sphinx 1.3b2 did the trick.
2015-01-08 08:04:11 +01:00
Thomas S Hatch
35af81b4b7 Merge pull request #19482 from JensRantil/warn-socketpath-early
Development bootstrap documentation improvements
2015-01-07 14:55:43 -07:00
Jens Rantil
30978b1070 doc(bootstrap-dev): mention short virtualenv path early
This was the second time I ran into this issue. Annoying after going
through all the steps of installing applications in the virtual
environment etc.
2015-01-07 22:25:31 +01:00
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