Skip to content

Commit

Permalink
Add developer docker docs
Browse files Browse the repository at this point in the history
  • Loading branch information
phlax committed May 23, 2019
1 parent f9eca6d commit fec5d4c
Show file tree
Hide file tree
Showing 2 changed files with 83 additions and 0 deletions.
82 changes: 82 additions & 0 deletions docs/developers/docker.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,82 @@
.. _docker:

Docker
======

You can install a development and test environment using docker.


.. _docker#assumptions:


Assumptions
-----------

- You have docker installed and working on your system
- The user you are using has permissions to use docker


.. _docker#virtualenv:

Create a virtualenv (optional)
------------------------------

Installing with virtualenv keeps your host environment clean, and separates
your development environment from the host.

For example:

.. code-block:: console
$ mkvirtualenv pootle
$ cd ~/virtualenvs/pootle
.. _docker#clone:

Clone the pootle repository
---------------------------

You most likely want to clone *your* fork of the pootle repository, so you
can easily create Pull Requests for your changes.

.. code-block:: console
(pootle): git clone [email protected]:$USER/pootle
(pootle): cd pootle/
.. _docker#requirements:

Install host requirements
-------------------------

.. code-block:: console
(pootle): pip install -r requirements/host.txt
.. _docker#install:

Install the pootle database
---------------------------

The default installer will create a postgresql database with

.. code-block:: console
(pootle): makey install-dev
This will take some time as it loads the default projects


.. _docker#server:

Run the development server
--------------------------

Once Pootle is installed you can run the development server with

.. code-block:: console
(pootle): makey runserver
1 change: 1 addition & 0 deletions docs/developers/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -24,3 +24,4 @@ other way, make sure to read through this part.
deprecation
releasing
plugins
docker

0 comments on commit fec5d4c

Please sign in to comment.