Skip to content

Commit

Permalink
Add note about CKAN directory and personal repo
Browse files Browse the repository at this point in the history
In order to help developers set up a CKAN development environment, they need to clone from a personal repository. This will make it easier to open a pull request, for developers who are not part of the CKAN organizaiton.

Also, there was a bit of ambiguity as to where to run the `pip install -e git+CKAN-repo` command. The command should be run from within `/usr/lib/ckan/default` so that subsequent steps work as expected.
  • Loading branch information
brylie committed Aug 2, 2017
1 parent cb5965e commit 07e4803
Showing 1 changed file with 16 additions and 0 deletions.
16 changes: 16 additions & 0 deletions doc/maintaining/installing/install-from-source.rst
Expand Up @@ -105,6 +105,13 @@ b. Install the recommended ``setuptools`` version:
pip install setuptools==\ |min_setuptools_version|
c. Install the CKAN source code into your virtualenv.
.. important::
For the following commands, make sure you are in your CKAN default directory. E.g.

.. parsed-literal::
cd /usr/lib/ckan/default/
To install the latest stable release of CKAN (CKAN |latest_release_version|),
run:

Expand All @@ -120,6 +127,15 @@ c. Install the CKAN source code into your virtualenv.
pip install -e 'git+\ |git_url|\#egg=ckan'
.. tip::

If you would like to work submit a pull request with your changes, be sure you are working from a cloned repository.
Use your personal repository URL instead of the CKAN repository. E.g.

.. parsed-literal::
pip install -e 'git=https://github.com/{your-username}/ckan.git#egg=ckan'
.. warning::

The development version may contain bugs and should not be used for
Expand Down

0 comments on commit 07e4803

Please sign in to comment.