diff --git a/src/postorius/doc/development.rst b/src/postorius/doc/development.rst index 3a5d31d..5e553db 100644 --- a/src/postorius/doc/development.rst +++ b/src/postorius/doc/development.rst @@ -8,21 +8,21 @@ Development Workflow ==================== -The source code is hosted on Launchpad_, which means that we are using +The source code is hosted on GitLab_, which means that we are using Bazaar for version control. -.. _Launchpad: https://launchpad.net/postorius +.. _GitLab: https://gitlab.com/mailman/postorius -Changes are usually not made directly in the project's trunk branch, but in +Changes are not made directly in the project's master branch, but in feature-related personal branches, which get reviewed and then merged into -the trunk. +the master branch. An ideal workflow would be like this: 1. File a bug to suggest a new feature or report a bug (or just pick one of the existing bugs). 2. Create a new branch with your code changes. -3. Make a "merge proposal" to get your code reviewed and merged. +3. Make a "merge request" to get your code reviewed and merged. Installing and running the tests @@ -152,4 +152,5 @@ For detailed information how to use mailman.client, check out its documentation_. -.. _documentation: http://bazaar.launchpad.net/~mailman-coders/mailman.client/trunk/view/head:/src/mailmanclient/docs/using.txt +.. _documentation: https://gitlab.com/mailman/mailmanclient/blob/master/src/mailmanclient/docs/using.rst + diff --git a/src/postorius/doc/setup.rst b/src/postorius/doc/setup.rst index 2f5c0a3..8276bcb 100644 --- a/src/postorius/doc/setup.rst +++ b/src/postorius/doc/setup.rst @@ -4,15 +4,14 @@ .. note:: This installation guide covers Postorius, the web user interface for - GNU Mailman 3. To install GNU Mailman follow the instructions in the documentation: - http://packages.python.org/mailman/ + GNU Mailman 3. To install GNU Mailman follow the instructions in the `documentation`_. If you are looking for an easy way to set up the whole GNU Mailman 3 suite (GNU Mailman 3, Postorius, Hyperkitty and mailman.client), check - out the `mailman-bundler`_ project on launchpad. + out the `mailman-bundler`_ project on GitLab. -.. _mailman-bundler: http://launchpad.net/mailman-bundler - +.. _mailman-bundler: https://gitlab.com/mailman/mailman-bundler +.. _documentation: https://pythonhosted.org/mailman/ Install Postorius ================= @@ -39,11 +38,11 @@ ------------------ If you want to always be up to date with the latest development version, you -should install Postorius using bazaar: +should install Postorius using git: :: - $ bzr branch lp:postorius + $ git clone git@gitlab.com:mailman/postorius.git $ cd postorius $ sudo python setup.py develop @@ -54,21 +53,20 @@ Since you have now installed the necessary packages to run Postorius, it's time to setup your Django site. -First, get the project directory from launchpad: +First, get the project directory from gitlab: :: - $ bzr branch lp:~mailman-coders/postorius/postorius_standalone + $ git clone git@gitlab.com:mailman/postorius_standalone.git Change the database setting in ``postorius_standalone/settings.py`` to -your preferred database. If you're OK with using sqlite, just change the path -in line 48 to the correct location. +your preferred database, if you want something other than SQlite. .. note:: Detailed information on how to use different database engines can be found in the `Django documentation`_. -.. _Django documentation: https://docs.djangoproject.com/en/1.6/ref/settings/#databases +.. _Django documentation: https://docs.djangoproject.com/en/1.8/ref/settings/#databases Third, prepare the database: