Show More
@@ -1,33 +1,36 | |||||
1 | .. _contributing: |
|
1 | .. _contributing: | |
2 |
|
2 | |||
3 | Contributing to RhodeCode |
|
3 | Contributing to RhodeCode | |
4 | ========================= |
|
4 | ========================= | |
5 |
|
5 | |||
6 | If you would like to contribute to RhodeCode, please contact me, any help is |
|
6 | If you would like to contribute to RhodeCode, please contact me, any help is | |
7 | greatly appreciated! |
|
7 | greatly appreciated! | |
8 |
|
8 | |||
9 | Could I request that you make your source contributions by first forking the |
|
9 | Could I request that you make your source contributions by first forking the | |
10 | RhodeCode repository on bitbucket_ |
|
10 | RhodeCode repository on bitbucket_ | |
11 | https://bitbucket.org/marcinkuzminski/rhodecode and then make your changes to |
|
11 | https://bitbucket.org/marcinkuzminski/rhodecode and then make your changes to | |
12 | your forked repository. Please post all fixes into **BETA** branch since your |
|
12 | your forked repository. Please post all fixes into **BETA** branch since your | |
13 | fix might be already fixed there and i try to merge all fixes from beta into |
|
13 | fix might be already fixed there and i try to merge all fixes from beta into | |
14 | stable, and not the other way. Finally, when you are finished making a change, |
|
14 | stable, and not the other way. Finally, when you are finished making a change, | |
15 | please send me a pull request. |
|
15 | please send me a pull request. | |
16 |
|
16 | |||
17 |
To run RhodeCode in a development version you always need to install the |
|
17 | To run RhodeCode in a development version you always need to install the latest | |
18 | version of RhodeCode and the VCS library. |
|
18 | required libs from `requires.txt` file. | |
19 |
|
19 | |||
20 | after downloading RhodeCode make sure you run:: |
|
20 | after downloading/pulling RhodeCode make sure you run:: | |
21 |
|
21 | |||
22 | python setup.py develop |
|
22 | python setup.py develop | |
23 |
|
23 | |||
24 |
command to install all required packages, and prepare development |
|
24 | command to install/verify all required packages, and prepare development | |
|
25 | enviroment. | |||
25 |
|
26 | |||
26 |
|
27 | |||
|
28 | After finishing your changes make sure all tests passes ok. You can run | |||
|
29 | the testsuite running nosetest from the project root. | |||
27 |
|
30 | |||
28 | | Thank you for any contributions! |
|
31 | | Thank you for any contributions! | |
29 | | Marcin |
|
32 | | Marcin | |
30 |
|
33 | |||
31 |
|
34 | |||
32 |
|
35 | |||
33 | .. _bitbucket: http://bitbucket.org/ |
|
36 | .. _bitbucket: http://bitbucket.org/ |
@@ -1,54 +1,54 | |||||
1 | .. _upgrade: |
|
1 | .. _upgrade: | |
2 |
|
2 | |||
3 | Upgrade |
|
3 | Upgrade | |
4 | ======= |
|
4 | ======= | |
5 |
|
5 | |||
6 | Upgrading from Cheese Shop |
|
6 | Upgrading from Cheese Shop | |
7 | -------------------------- |
|
7 | -------------------------- | |
8 |
|
8 | |||
9 | .. note:: |
|
9 | .. note:: | |
10 | Firstly, it is recommended that you **always** perform a database backup |
|
10 | Firstly, it is recommended that you **always** perform a database backup | |
11 | before doing an upgrade. |
|
11 | before doing an upgrade. | |
12 |
|
12 | |||
13 | The easiest way to upgrade ``rhodecode`` is to run:: |
|
13 | The easiest way to upgrade ``rhodecode`` is to run:: | |
14 |
|
14 | |||
15 | easy_install -U rhodecode |
|
15 | easy_install -U rhodecode | |
16 |
|
16 | |||
17 | Or:: |
|
17 | Or:: | |
18 |
|
18 | |||
19 | pip install --upgrade rhodecode |
|
19 | pip install --upgrade rhodecode | |
20 |
|
20 | |||
21 |
|
21 | |||
22 | Then make sure you run the following command from the installation directory:: |
|
22 | Then make sure you run the following command from the installation directory:: | |
23 |
|
23 | |||
24 | paster make-config RhodeCode production.ini |
|
24 | paster make-config RhodeCode production.ini | |
25 |
|
25 | |||
26 | This will display any changes made by the new version of RhodeCode to your |
|
26 | This will display any changes made by the new version of RhodeCode to your | |
27 | current configuration. It will try to perform an automerge. It's always better |
|
27 | current configuration. It will try to perform an automerge. It's always better | |
28 | to make a backup of your configuration file before hand and recheck the |
|
28 | to make a backup of your configuration file before hand and re check the | |
29 | content after the automerge. |
|
29 | content after the automerge. | |
30 |
|
30 | |||
31 | .. note:: |
|
31 | .. note:: | |
32 | Please always make sure your .ini files are upto date. Often errors are |
|
32 | Please always make sure your .ini files are up to date. Often errors are | |
33 | caused by missing params added in new versions. |
|
33 | caused by missing params added in new versions. | |
34 |
|
34 | |||
35 |
|
35 | |||
36 | It is also recommended that you rebuild the whoosh index after upgrading since |
|
36 | It is also recommended that you rebuild the whoosh index after upgrading since | |
37 | the new whoosh version could introduce some incompatible index changes. Please |
|
37 | the new whoosh version could introduce some incompatible index changes. Please | |
38 | Read the changelog to see if there were any changes to whoosh. |
|
38 | Read the changelog to see if there were any changes to whoosh. | |
39 |
|
39 | |||
40 |
|
40 | |||
41 | The final step is to upgrade the database. To do this simply run:: |
|
41 | The final step is to upgrade the database. To do this simply run:: | |
42 |
|
42 | |||
43 | paster upgrade-db production.ini |
|
43 | paster upgrade-db production.ini | |
44 |
|
44 | |||
45 | This will upgrade the schema and update some of the defaults in the database, |
|
45 | This will upgrade the schema and update some of the defaults in the database, | |
46 | and will always recheck the settings of the application, if there are no new |
|
46 | and will always recheck the settings of the application, if there are no new | |
47 | options that need to be set. |
|
47 | options that need to be set. | |
48 |
|
48 | |||
49 |
|
49 | |||
50 | .. _virtualenv: http://pypi.python.org/pypi/virtualenv |
|
50 | .. _virtualenv: http://pypi.python.org/pypi/virtualenv | |
51 | .. _python: http://www.python.org/ |
|
51 | .. _python: http://www.python.org/ | |
52 | .. _mercurial: http://mercurial.selenic.com/ |
|
52 | .. _mercurial: http://mercurial.selenic.com/ | |
53 | .. _celery: http://celeryproject.org/ |
|
53 | .. _celery: http://celeryproject.org/ | |
54 | .. _rabbitmq: http://www.rabbitmq.com/ No newline at end of file |
|
54 | .. _rabbitmq: http://www.rabbitmq.com/ |
General Comments 0
You need to be logged in to leave comments.
Login now