##// END OF EJS Templates
docs: updated contribution and dev setup docs.
marcink -
r1418:ddc4721b default
parent child Browse files
Show More
@@ -32,7 +32,7 b' following commands:'
32 32
33 33 .. tip::
34 34
35 Update your channels frequently by running ``nix-channel --upgrade``.
35 Update your channels frequently by running ``nix-channel --update``.
36 36
37 37
38 38 Switch nix to the latest STABLE channel
@@ -63,7 +63,10 b' Clone the required repositories'
63 63
64 64 After Nix is set up, clone the RhodeCode Enterprise Community Edition and
65 65 RhodeCode VCSServer repositories into the same directory.
66 To do this, use the following example::
66 RhodeCode currently is using Mercurial Version Control System, please make sure
67 you have it installed before continuing.
68
69 To obtain the required sources, use the following commands:
67 70
68 71 mkdir rhodecode-develop && cd rhodecode-develop
69 72 hg clone https://code.rhodecode.com/rhodecode-enterprise-ce
@@ -71,8 +74,7 b' To do this, use the following example::'
71 74
72 75 .. note::
73 76
74 If you cannot clone the repository, please request read permissions
75 via support@rhodecode.com
77 If you cannot clone the repository, please contact us via support@rhodecode.com
76 78
77 79
78 80 Install some required libraries
@@ -94,9 +96,14 b' required libraries::'
94 96 Enter the Development Shell
95 97 ---------------------------
96 98
97 The final step is to start the development shell. To do this, run the
99 The final step is to start the development shells. To do this, run the
98 100 following command from inside the cloned repository::
99 101
102 #first, the vcsserver
103 cd ~/rhodecode-vcsserver
104 nix-shell
105
106 # then enterprise sources
100 107 cd ~/rhodecode-enterprise-ce
101 108 nix-shell
102 109
@@ -114,19 +121,22 b' Creating a Development Configuration'
114 121 To create a development environment for RhodeCode Enterprise,
115 122 use the following steps:
116 123
117 1. Create a copy of `~/rhodecode-enterprise-ce/configs/development.ini`
118 2. Adjust the configuration settings to your needs
124 1. Create a copy of vcsserver config:
125 `cp ~/rhodecode-vcsserver/configs/development.ini ~/rhodecode-vcsserver/configs/dev.ini`
126 2. Create a copy of rhodocode config:
127 `cp ~/rhodecode-enterprise-ce/configs/development.ini ~/rhodecode-enterprise-ce/configs/dev.ini`
128 3. Adjust the configuration settings to your needs if needed.
119 129
120 130 .. note::
121 131
122 It is recommended to use the name `dev.ini`.
132 It is recommended to use the name `dev.ini` since it's included in .hgignore file.
123 133
124 134
125 135 Setup the Development Database
126 136 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
127 137
128 138 To create a development database, use the following example. This is a one
129 time operation::
139 time operation executed from the nix-shell of rhodecode-enterprise-ce sources ::
130 140
131 141 paster setup-rhodecode dev.ini \
132 142 --user=admin --password=secret \
@@ -150,24 +160,23 b' changes made to the CSS or JavaScript fi'
150 160
151 161 This prepares the development (with comments/whitespace) versions of files.
152 162
153 Start the Development Server
154 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^
163 Start the Development Servers
164 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
155 165
156 166 From the rhodecode-vcsserver directory, start the development server in another
157 167 nix-shell, using the following command::
158 168
159 pserve configs/development.ini http_port=9900
169 pserve configs/dev.ini
160 170
161 171 In the adjacent nix-shell which you created for your development server, you may
162 172 now start CE with the following command::
163 173
164 174
165 rcserver dev.ini
175 pserve --reload configs/dev.ini
166 176
167 177 .. note::
168 178
169 To automatically refresh - and recompile the frontend assets - when changes
170 are made in the source code, you can use the option `--reload`.
179 `--reload` flag will automatically reload the server when source file changes.
171 180
172 181
173 182 Run the Environment Tests
General Comments 0
You need to be logged in to leave comments. Login now