From 4d80338ddc9121879a968d8de75e36176c0000fa Mon Sep 17 00:00:00 2001 From: Ryan Northey Date: Wed, 4 Apr 2018 12:25:23 +0100 Subject: [PATCH] Add developer docker docs --- docs/developers/docker.rst | 82 ++++++++++++++++++++++++++++++++++++++ docs/developers/index.rst | 1 + 2 files changed, 83 insertions(+) create mode 100644 docs/developers/docker.rst diff --git a/docs/developers/docker.rst b/docs/developers/docker.rst new file mode 100644 index 00000000000..c928cab0dba --- /dev/null +++ b/docs/developers/docker.rst @@ -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 git@github.com:$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 diff --git a/docs/developers/index.rst b/docs/developers/index.rst index d669a87dd90..809d7620772 100644 --- a/docs/developers/index.rst +++ b/docs/developers/index.rst @@ -24,3 +24,4 @@ other way, make sure to read through this part. deprecation releasing plugins + docker