Commit Graph

48 Commits

Author SHA1 Message Date
Erik Johnson
29ec37be33 Add quick paragraph about needing compiler
A compiler is required to build M2Crypto, this commit adds a short
paragraph as a reminder of this fact.
2013-12-21 11:45:21 -06:00
Erik Johnson
c88269351b Remove references to yumpkg in documentation 2013-12-13 18:01:34 -06:00
Henrik Holmboe
3179e97cc8 Unify documentation regarding the test suite
There were a whole lot of information regarding running the test suite
in the hacking file, while there are a separate tests section of the
documentation. I attempt to slim this down a bit and give a helpful
pointer to the full section in order to avoid duplicated texts.
2013-11-11 19:55:21 +01:00
Henrik Holmboe
06ae6e111d Change header title
Aligns better with the previous header which is "Installing Salt for
development".
2013-11-11 19:47:55 +01:00
Chris Rebert
31ad8ee653 copyedit recently-enhanced docs 2013-10-24 23:31:13 -07:00
Forrest Alvarez
32a3d82595 Merge remote branch 'upstream/develop' into develop 2013-10-24 03:37:11 +00:00
Henrik Holmboe
218b842068 I always have to look up these :) 2013-10-23 17:05:56 +02:00
Forrest Alvarez
b64dc90a20 updated hacking (developing) tutorial with information on running a simplye python http server to show changes that you have made. 2013-10-23 05:23:24 +00:00
Mike Place
766b3f405d The documentation for 'Developing Salt' is missing a critical step for 0.17+ users who wish to utilize the test runner. This commit describes the direct installation of salt-testing.
Forthcoming will be a re-write what appears to be a new method for establishing a development environment through the use of dev_requirements_python2(6|7).txt, once I have a chance to verify
that the workflow is as expected.
2013-10-04 12:06:43 -06:00
Pedro Algarvio
ebf848dfb4 Add an anchor to the enable Travis-CI note. 2013-08-29 10:52:38 +00: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
c3ca853582 Use double-colon to make cmdline example use PRE tag in docs 2013-07-28 18:06:37 -05:00
Pedro Algarvio
09671fe759 Moved deprecation documentation to it's own document under topics/development 2013-07-20 19:18:55 +01:00
Pedro Algarvio
e38287f25e Document the deprecation procedure to follow and how to use the helper class. 2013-07-20 18:19:50 +01:00
Chris Rebert
bf530eeb27 correctly capitalize GitHub 2013-07-02 19:23:44 -07:00
Erik Johnson
88d7839cef Replace 2nd-person wording
This commit re-does the updates from #5536 without using 2nd-person
pronouns.
2013-06-13 21:05:19 -05:00
Erik Johnson
c80845ff74 Clean up docs on building with sphinx-build
Also added details on how to build the docs on RHEL/CentOS 6.
2013-06-13 20:29:17 -05:00
Chris Rebert
498d2999db more typo fixes 2013-05-01 16:52:52 -07:00
Erik Johnson
a0d0db6ed1 Add docs on installing w/easy_install 2013-04-07 17:05:31 -05:00
Erik Johnson
5b4df95b2b Added notes on installing psutil via pip
Python header files are required, and may not be installed depending on
your distro. Added a paragraph mentioning this.
2013-03-24 11:51:51 -05:00
John Albietz
be9b612ba7 fork and branch instructions more accurate now 2013-02-07 23:10:41 -08:00
John Albietz
8d4d2a1812 added missing set-upstream flag 2013-02-07 22:45:28 -08:00
Tony Narlock
06b5923ce1 Fix link to OS X installation docs 2013-02-07 17:58:26 -06:00
John Albietz
733a5b9825 hacking on osx. a few typos. more 1st person nuke.
removed more of the first-person stuff. referred to the new osx docs for specific info.
2013-02-06 10:37:20 -08:00
Stephen McQuay
7ca812c40a Notes for things I had to do on my OS X laptop. 2013-02-02 00:06:40 -08:00
ydavid365
a13cd103c9 changes to tense in response to @thatch45. clarified a few things. 2013-02-01 14:36:41 -08:00
ydavid365
6b66841b34 git format-patch link 2013-02-01 14:20:22 -08:00
ydavid365
c0147f68f8 removed unnecessary sentence. clarified branch naming. 2013-02-01 13:35:12 -08:00
ydavid365
55f1a42a35 better travis-ci formatting 2013-02-01 13:18:40 -08:00
ydavid365
ae55275975 updated instructions to make github info mostly self-contained 2013-02-01 13:03:44 -08:00
ydavid365
d034db0765 updated dev contrib doc 2013-02-01 12:31:40 -08:00
Seth House
567a1edac7 Misc rST fixes 2013-01-23 23:40:24 -07:00
Baiju Muthukadan
8e238d21e0 move documenatation generation to bottom
Installing Salt is required for auto-generated
module documentation.  Also mentioned about Sphinx
installation using pip.
2013-01-23 16:39:36 +05:30
Sean Channel
a7a1c01530 merge differences and mention fetching tags 2013-01-16 16:42:32 -08:00
Pedro Algarvio
dd0258b3e4 Include Travis-CI in the hacking doc, it makes our life easier. 2013-01-03 18:51:44 +00:00
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
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
Erik Johnson
9a878c7400 Update hacking docs 2012-12-26 20:44:15 -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
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
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
dca280a232 Add auth package to setup.py 2012-10-03 13:57:36 -06:00
Wraithan (Chris McDonald)
624896c274 fix doc symlink 2012-06-30 17:47:26 -07:00
Wraithan (Chris McDonald)
910f936d71 Improve hacking docs 2012-06-30 17:28:08 -07:00