Erik Johnson
93ee5ee2b0
Fix all Sphinx warnings
...
Well, all but one, which we expect to see
2018-05-31 15:28:25 -05:00
Jacob Hammons
b192a9ba38
Doc restructuring, organization, and cleanup. Updated the doc navigation.
2016-01-31 20:10:02 -07:00
rallytime
45080f3629
Add examples of using multiple matching levels to Pillar docs
...
Fixes #29091
2015-12-15 14:57:36 -07:00
Colton Myers
35425b14ad
Merge remote-tracking branch 'upstream/2015.5' into merge-forward-2015.8
...
Conflicts:
doc/man/salt-api.1
doc/man/salt-call.1
doc/man/salt-cloud.1
doc/man/salt-cp.1
doc/man/salt-key.1
doc/man/salt-master.1
doc/man/salt-minion.1
doc/man/salt-run.1
doc/man/salt-ssh.1
doc/man/salt-syndic.1
doc/man/salt-unity.1
doc/man/salt.1
doc/man/salt.7
salt/modules/pip.py
salt/states/user.py
2015-10-07 12:06:12 -06:00
Stephen Medina
a9063a9745
fix typo in default pillar path
...
I am a newb and this threw me off for a bit. Wanted to make it consistent with the rest of the doc.
2015-10-02 16:50:28 -06:00
Colton Myers
76e468bc20
Merge remote-tracking branch 'upstream/2015.5' into merge-forward-2015.8
...
Conflicts:
doc/topics/cloud/vmware.rst
salt/cloud/clouds/digital_ocean_v2.py
salt/cloud/clouds/vmware.py
salt/daemons/flo/core.py
salt/modules/hipchat.py
salt/modules/lxc.py
salt/modules/rabbitmq.py
salt/pillar/s3.py
salt/states/dockerio.py
salt/states/file.py
salt/utils/process.py
salt/utils/s3.py
2015-07-20 13:55:14 -06:00
David Beitey
3e24381439
Fix minor typo in best practice example
2015-07-18 08:24:53 -06:00
Damian Myerscough
916519c333
Fixing spacing typo
2015-06-17 14:54:58 -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
d0f038eec0
Minor clarification to not pointing directly to formulas repos
2014-12-12 17:42:54 -07:00
Seth House
e7922758ae
Minor rST formatting
2014-12-12 17:42:53 -07:00
Thomas Jackson
4d41fa35a1
Comma cleanup
2014-12-12 11:40:36 -08: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
Forrest Alvarez
fec0c4e035
Update best_practices to resolve issue where slspath is used, but not yet implemented/explained.
2014-08-13 04:57:14 +00:00
steverweber
0b764c5b69
add two vars to the templates slspath and tplpath
2014-07-29 09:53:19 -04:00
Forrest Alvarez
55916e8a7b
Update best_practices doc for code block issues.
2014-06-29 00:37:29 +00:00
Ryan Lane
5ade41681d
Give warning about using grains as pillar matches
...
If you use grains to match for pillar top files, any sensitive data
in the pillars is no longer protected, as any minion could modify its
grains to access the sensitive pillars.
2014-03-28 14:34:03 -07:00
Forrest Alvarez
cd4206b1da
A few fixes to use :ref: and :formula: instead of :doc:.
2014-03-19 04:00:42 +00:00
Forrest Alvarez
20c41d5c14
Fixed some line lenghts for the best practices.
2014-03-18 04:16:30 +00:00
Forrest Alvarez
c7ddf94c18
Fixed some issues with links inside of the best practice docs.
2014-03-18 04:14:42 +00:00
Seth House
07802e34c5
Added best practice, jobs, and scheduler headings to the index
2014-03-01 23:13:23 -07:00
Forrest Alvarez
f8f98a383d
Fixed a few line length issues.
2014-02-27 23:57:16 +00:00
Mike Place
06e5a44071
Grammar and clarity.
2014-02-26 22:48:31 -07:00
Forrest Alvarez
eee506eabb
updated best practices with some first thoughts on general rules per suggestion by cachedout.
2014-02-27 05:25:32 +00:00
Forrest Alvarez
fb34f79f29
merged in upstream.
2014-02-27 04:55:53 +00:00
Forrest Alvarez
e4aea793da
Added doc to contents file, fixed an error.
2014-02-16 04:33:12 +00:00
Forrest Alvarez
86970c933c
Fixed some grammar issues.
2014-02-16 04:17:05 +00:00
Forrest Alvarez
237b80a2fb
Updated best practices for a typo for the sls reference.
2014-02-16 04:11:10 +00:00
Forrest Alvarez
3f68dd00c8
Updated examples to fix a few syntax issues, modified an example to give it a more realistic structure.
2014-02-16 04:07:22 +00:00
Forrest Alvarez
fb1b56cbe1
Added some more example info for a somewhat confusing section.
2014-02-16 04:00:11 +00:00
Forrest Alvarez
9ef5afd58f
Fleshed out a ton of sections, added more verbose examples.
2014-02-16 03:51:37 +00:00
Forrest Alvarez
f23fd229e1
add another link, fix some formatting.
2014-02-16 02:17:17 +00:00
Forrest Alvarez
e43bffbe5c
Fix the formulas link.
2014-02-16 02:14:53 +00:00
Forrest Alvarez
08628199d0
Link fix.
2014-02-16 02:13:49 +00:00
Forrest Alvarez
856f621e87
Added some links.
2014-02-16 02:12:52 +00:00
Forrest Alvarez
d340a9b92d
Fleshing out the section on pillars, restructured part of the doc to provide a better flow.
2014-02-16 01:42:45 +00:00
Forrest Alvarez
02a1de2992
Added an initial draft of some of the beginning of the pillar section, still needs to be revised.
2014-02-13 05:45:44 +00:00
Forrest Alvarez
8e7c73f172
Fixed a typo in the best practices doc for referencing location of vim content.
2014-02-13 05:28:29 +00:00
Forrest Alvarez
2decc6a617
first working draft of a best practices document.
2014-02-06 16:30:19 +00:00
