Files
@ 64b1a2320bcb
Branch filter:
Location: kallithea/docs/contributing.rst - annotation
64b1a2320bcb
1.9 KiB
text/prs.fallenstein.rst
docs: update Windows installation documentation for Windows 7/Server 2008 R2 and newer
Update to the Windows installation documentation following my setup experience
on our production server.
Changes :
* Use of Microsoft Visual C++ Compiler for Python 2.7 which simplifies matter
versus installing Visual Studio 2008 Express, because it removes the need
to use the Visual Studio 2008 command prompt. It is also a lot smaller to
download and install. Unfortunately, this means the instruction will only
work on the same platforms as those which are supported by the compiler.
* For that reason, I split the documentation into newer and older Windows.
* Added more explanations where I feel it was necessary based on my experience
* Added explanation on Git (Warning : I did not try this part)
* Instructions assumes x64 instead of Win32.
* Clarified titles
* Grammar
Potential issues:
* I have the user install pip system wide so that virtualenv installation is
easier (especially if using Python 2.7.9 which already includes pip). One
may prefer to install virtualenv and the pip in the virtual environment (I
know of no good reason, but it could happen).
* Removed some line feeds that I found useless. I do not know the .rst
format, they might be needed. It makes no difference when the documentation
is generated using make.bat, so I am not sure
Potential improvements:
* Instructions on using srvany.exe to install as a Windows service
* Instructions to make a reverse proxy using Apache
* Instructions to make a reverse proxy using IIS
Update to the Windows installation documentation following my setup experience
on our production server.
Changes :
* Use of Microsoft Visual C++ Compiler for Python 2.7 which simplifies matter
versus installing Visual Studio 2008 Express, because it removes the need
to use the Visual Studio 2008 command prompt. It is also a lot smaller to
download and install. Unfortunately, this means the instruction will only
work on the same platforms as those which are supported by the compiler.
* For that reason, I split the documentation into newer and older Windows.
* Added more explanations where I feel it was necessary based on my experience
* Added explanation on Git (Warning : I did not try this part)
* Instructions assumes x64 instead of Win32.
* Clarified titles
* Grammar
Potential issues:
* I have the user install pip system wide so that virtualenv installation is
easier (especially if using Python 2.7.9 which already includes pip). One
may prefer to install virtualenv and the pip in the virtual environment (I
know of no good reason, but it could happen).
* Removed some line feeds that I found useless. I do not know the .rst
format, they might be needed. It makes no difference when the documentation
is generated using make.bat, so I am not sure
Potential improvements:
* Instructions on using srvany.exe to install as a Windows service
* Instructions to make a reverse proxy using Apache
* Instructions to make a reverse proxy using IIS
bb35ad076e2f bb35ad076e2f 17c9393e9645 e73a69cb98dc bb35ad076e2f bb35ad076e2f e73a69cb98dc 8af52e1224ff bb35ad076e2f 8af52e1224ff e73a69cb98dc 010e9532801a b53cef6faf22 b53cef6faf22 b53cef6faf22 e73a69cb98dc 053983a464e4 e73a69cb98dc e73a69cb98dc b53cef6faf22 010e9532801a 053983a464e4 e73a69cb98dc 950110f3f99f 950110f3f99f 950110f3f99f 8b8edfc25856 6fdc3b25bc7c 950110f3f99f b53cef6faf22 b53cef6faf22 b53cef6faf22 950110f3f99f 6fdc3b25bc7c 1b9d6b0a92b3 a9a1560dad79 b53cef6faf22 b53cef6faf22 b53cef6faf22 b53cef6faf22 b53cef6faf22 b53cef6faf22 b53cef6faf22 703d3208424c b53cef6faf22 b53cef6faf22 950110f3f99f 8af52e1224ff 9472a0150bf0 9472a0150bf0 9472a0150bf0 | .. _contributing:
=========================
Contributing to Kallithea
=========================
If you would like to contribute to Kallithea, please contact us, any help is
greatly appreciated!
Could I request that you make your source contributions by first forking the
Kallithea repository on bitbucket_
https://bitbucket.org/conservancy/kallithea and then make your changes to
your forked repository. Please post all fixes into **dev** bookmark since your
change might be already fixed there and i try to merge all fixes from dev into
stable, and not the other way. Finally, when you are finished with your changes,
please send us a pull request.
To run Kallithea in a development version you always need to install the latest
required libs. Simply clone Kallithea and switch to beta branch::
hg clone https://kallithea-scm.org/repos/kallithea
after downloading/pulling Kallithea make sure you run::
python setup.py develop
command to install/verify all required packages, and prepare development
enviroment.
There are two files in the directory production.ini and developement.ini copy
the `development.ini` file as rc.ini (which is excluded from version controll)
and put all your changes like db connection or server port in there.
After finishing your changes make sure all tests passes ok. You can run
the testsuite running ``nosetest`` from the project root, or if you use tox
run tox for python2.6-2.7 with multiple database test. When using `nosetests`
test.ini file is used and by default it uses sqlite for tests, edit this file
to change your testing enviroment.
There's a special set of tests for push/pull operations, you can runn them using::
paster serve test.ini --pid-file=test.pid --daemon
KALLITHEA_WHOOSH_TEST_DISABLE=1 KALLITHEA_NO_TMP_PATH=1 nosetests -x kallithea/tests/other/test_vcs_operations.py
kill -9 $(cat test.pid)
| Thank you for any contributions!
.. _bitbucket: http://bitbucket.org/
|