Commit Graph

935 Commits

Author SHA1 Message Date
Erik Johnson
70f14c6c0f Remove sentence from development virtualenv docs
Per https://github.com/saltstack/salt/pull/3042#issuecomment-11715005
2012-12-27 23:32:48 -06:00
Godefroid Chapelle
6c74931ea8 Update doc/ref/states/highstate.rst
fix Rest formatting mistakes
2012-12-27 20:12:18 +01:00
Erik Johnson
23ca7f049a Clarify virtualenv installation/configuration docs
Since the "pidfile" param has been added to the list of params for which
root_dir is prepended, editing the pidfile is no longer necessary when
running from a recent git checkout. Added a note to clarify this.
2012-12-27 11:51:56 -06:00
Thomas S Hatch
c197152210 Merge pull request #3041 from archtaku/docs
cleanup for 8bb8143
2012-12-27 09:32:11 -08:00
Erik Johnson
6739eca926 cleanup for 8bb8143 2012-12-27 11:29:46 -06:00
Thomas S Hatch
ba42755935 Add explanation of "issue" to overstate doc 2012-12-27 09:55:15 -07:00
Thomas S Hatch
2971bf4e8e Merge pull request #3031 from archtaku/docs
Add missing config params to minion conf docs
2012-12-27 08:46:44 -08:00
Godefroid Chapelle
ef00765f30 Update doc/ref/states/highstate.rst
More details in large example
2012-12-27 10:47:23 +01:00
Erik Johnson
8bb8143ee3 Add missing config params to minion conf docs
I noticed earlier tonight when I added some information to the "hacking"
docs that my "root_dir" and "sock_dir" links were not actually linking
to anything, and found that they were missing from the minion
configuration page. It turns out that there were a good many params that
hadn't made their way into the docs yet, so I added as many of them as
I could identify.
2012-12-26 22:58:35 -06:00
Erik Johnson
9a878c7400 Update hacking docs 2012-12-26 20:44:15 -06:00
Erik Johnson
92ab669a1f Provider doc enhancements
1) Added an example for the minion config option "providers".

2) Cleaned up line widths on solaris install instructions, and added
   information on how to use pkgutil as the default package provider.

3) Since systemd is the default provider for Arch Linux now, I corrected
   the information in the "State Providers" page so that the example of
   overriding the service provider reflects the current state of the
   codebase.
2012-12-21 21:40:01 -06:00
Erik Johnson
36252d5dfb Add notes for developing on RedHat variants 2012-12-21 18:23:33 -06:00
Erik Johnson
5b3e592fd0 More clarification/correction to hacking docs
Running pip install -e /path/to/git/clone from within the virtualenv
does not also install salt's additional required modules, as the
document suggests. I ran into this issue last week and so did a guy I
was helping troubleshoot in #salt.

Also, I clarified the bit about using --system-site-packages in your
virtualenv.
2012-12-21 16:00:50 -06:00
Ondrej Kupka
f49506f38e Make sure the Portage package name is unambiguous 2012-12-21 19:20:41 +01:00
Ondrej Kupka
bfe70f7405 Update Gentoo installation manual 2012-12-21 19:05:33 +01:00
Alec Koumjian
26ac0437fe Add bootstrap and prioritize platform instructions to install 2012-12-20 21:21:59 -08:00
Thomas S Hatch
d217fd9f49 update contents to have the git policy 2012-12-20 16:08:10 -07:00
Thomas S Hatch
d19bf88a53 Add style guide to the toc 2012-12-20 14:17:39 -07:00
Clint Savage
3cd8c56875 fixing typos is fun! 2012-12-20 13:22:17 -07:00
Thomas S Hatch
892a371b87 Fix #1775 by adding a coding style 2012-12-20 12:35:27 -07:00
Sean Channel
8adee9532a both ways to add repo 2012-12-20 11:20:48 -08:00
Thomas S Hatch
25aaabdd39 Merge pull request #2969 from nkuttler/doc_debian
Update the incorrect Debian install information
2012-12-20 08:34:30 -08:00
Thomas S Hatch
169c5314c4 Merge pull request #2968 from nkuttler/doc_fixes
Fix three small typos
2012-12-20 08:33:59 -08:00
Nicolas Kuttler
947d40adf2 Update the incorrect Debian install information 2012-12-20 17:15:05 +01:00
Nicolas Kuttler
657878dcdc Add missing colons 2012-12-20 16:51:30 +01:00
David Boucha
90c073a2eb Fix typos and grammar. Some clarifications 2012-12-20 08:22:31 -07:00
Thomas S Hatch
3fcaba4caf Hook reactor docs into the table of contents 2012-12-19 22:10:46 -07:00
Thomas S Hatch
29f2132ca9 Get some reactor docs up 2012-12-19 22:09:44 -07:00
David Boucha
1aa4477eae Merge pull request #2957 from UtahDave/develop
fix small typo - globbing, not globing
2012-12-19 14:53:19 -08:00
David Boucha
8d64d123d6 fix small typo - globbing, not globing 2012-12-19 15:52:12 -07:00
Erik Johnson
7415755653 More docs updates
Added the same links to returner and renderer docs as I did for grains,
states, and modules last night.
2012-12-19 14:35:43 -06:00
Erik Johnson
5def1dd54c Updated docs for grains, modules, and states
Added links to module function documentation, as well as to
"file_roots", and mentioned the saltutil.sync_* functions. Will probably
do the same for returners and renderers soon. This should help people
navigate through the docs easier.
2012-12-18 23:29:36 -06:00
Thomas S Hatch
77df0a2dbf Start on the reactor docs 2012-12-18 16:34:22 -07:00
Thomas S Hatch
5648117b8b Add release docs 2012-12-18 14:51:42 -07:00
Thomas S Hatch
98f34e2410 Merge pull request #2915 from archtaku/docs
Improvements to "hacking" docs
2012-12-17 07:36:13 -08:00
Thomas S Hatch
dd0655191b Add more info about the pki dir change in 0.11.0 2012-12-17 08:28:49 -07:00
Erik Johnson
afbd18db67 Tweaked the info on running in debug mode
Sorry for the repeated commits, but this wording seemed better, and
doesn't presume that running in debug mode means you should forgo a log
file.
2012-12-16 12:57:00 -06:00
Erik Johnson
f4556e2e7e Move info about pidfile into master/minion config
Thanks to s0undt3ch for suggesting this. Anything to type less on the
command line :)

Also, the filenames for the master and minion templates are "master" and
"minion", not "master.template" and "minion.template". Corrected this.
2012-12-16 02:17:44 -06:00
Erik Johnson
15cd4278a4 change reference to 0.10.6 to 0.11.0 2012-12-16 01:25:05 -06:00
Erik Johnson
343446ba5f misc formatting fixes 2012-12-16 01:13:32 -06:00
Erik Johnson
314bda89fd Add a "cd" so that relative paths make sense 2012-12-16 01:03:47 -06:00
Erik Johnson
1333d21539 Improvements to "hacking" docs
Salt has a lot of Arch Linux users (after all, Arch is the best!), so
I added some information on building the docs in Arch where the python2
version of sphinx-build is called sphinx-build2

Also, when setting up a standalone development environment in a
virtualenv, unless you are running as root (and the docs explicitly
direct you not to do so) you will not have write access to /var/run in
order to create the pidfile. So, the --pid-file argument should be used
to specify a different path.

Finally, a note on running the master and minion in the foreground in
debug mode was added.
2012-12-16 00:45:50 -06:00
Thomas S Hatch
66b4f36e52 update manpages to 0.11.0 2012-12-14 06:50:47 -07:00
Thomas S Hatch
5bee3b8c15 update salt-syndic manpage 2012-12-14 06:48:46 -07:00
Thomas S Hatch
49dfd75660 remove deprecated --config 2012-12-14 06:48:11 -07:00
Thomas S Hatch
e12df0b745 update the salt-run manpage 2012-12-14 06:47:26 -07:00
Thomas S Hatch
1924df2f4b update the salt-minion manpage 2012-12-14 06:46:30 -07:00
Thomas S Hatch
64655a2ca4 Add version options to salt-key manpage 2012-12-14 06:45:31 -07:00
Thomas S Hatch
61792628ae Add --versions-report to salt-call manpage 2012-12-14 06:44:23 -07:00
Thomas S Hatch
025736216f Add --versions-report to salt manpage 2012-12-14 06:43:05 -07:00