Skip to content

Commit

Permalink
Include setting up local devel environment as separate chapter
Browse files Browse the repository at this point in the history
this commit adds another entry in TOC but still keeps the devel
instructions included in the chapter Contribute!
  • Loading branch information
atodorov committed Oct 31, 2017
1 parent cc71843 commit baf579a
Show file tree
Hide file tree
Showing 3 changed files with 9 additions and 7 deletions.
1 change: 1 addition & 0 deletions docs/source/contribution.rst
Expand Up @@ -10,6 +10,7 @@ able to contribute in various areas, whatever you are a good and experienced
developer, documentation writer or even a normal user.

.. include:: set_dev_env.rst
:start-line: 2

Testing
-------
Expand Down
3 changes: 2 additions & 1 deletion docs/source/index.rst
Expand Up @@ -11,7 +11,8 @@ Kiwi TCMS documentation
:numbered:

About Kiwi TCMS <about.rst>
installing_docker.rst
Running Kiwi TCMS in production with Docker <installing_docker.rst>
Running Kiwi TCMS locally for development <set_dev_env.rst>
configuration.rst
tutorial.rst
contribution.rst
Expand Down
12 changes: 6 additions & 6 deletions docs/source/set_dev_env.rst
@@ -1,15 +1,15 @@
Setting up a local development environment
------------------------------------------
==========================================

Get source code
~~~~~~~~~~~~~~~
---------------

The Kiwi TCMS source code is available at: https://github.com/kiwitcms/Kiwi::

git clone https://github.com/kiwitcms/Kiwi.git

Install Python 3
~~~~~~~~~~~~~~~~
----------------

Kiwi TCMS is a Python 3 project! On CentOS 7 this is available via
`SoftwareCollections.org <https://www.softwarecollections.org/en/scls/rhscl/rh-python35/>`_.
Expand All @@ -27,15 +27,15 @@ for more details on how to install and enable Python 3!
``Dockerfile`` to find out the latest version which we use!

Setup virtualenv
~~~~~~~~~~~~~~~~
----------------

Create a virtual environment for Kiwi TCMS::

virtualenv ~/virtualenvs/kiwi


Dependencies
~~~~~~~~~~~~
------------

First install RPM packages which are needed to compile some of the Python dependencies::

Expand Down Expand Up @@ -81,7 +81,7 @@ Load database schema and create initial user::
./manage.py createsuperuser

Let's run Kiwi TCMS
---------------------
-------------------

You're now ready to start the server::

Expand Down

0 comments on commit baf579a

Please sign in to comment.