From 918dfa8553bd8a7cd2a795ad67ec27fa017d4d12 Mon Sep 17 00:00:00 2001 From: Pierre-Yves Chibon Date: Aug 10 2016 12:51:52 +0000 Subject: Misc fixes to the doc, formatting and links --- diff --git a/doc/install.rst b/doc/install.rst index 74ccb81..b5dfb38 100644 --- a/doc/install.rst +++ b/doc/install.rst @@ -254,9 +254,10 @@ where the file ``alembic.ini`` is. This file contains two important pieces of information: * ``sqlalchemy.url`` which is the URL used to connect to the database, likely -the same URL as the one in ``pagure.cfg``. + the same URL as the one in ``pagure.cfg``. + * ``script_location`` which is the path to the ``versions`` folder containing -all the alembic migration files. + all the alembic migration files. The ``alembic stamp`` command is the one actually saving the current revision into the database. This current revision is found using ``alembic heads`` diff --git a/doc/usage/roadmap.rst b/doc/usage/roadmap.rst index e1b7cd5..8f4c400 100644 --- a/doc/usage/roadmap.rst +++ b/doc/usage/roadmap.rst @@ -7,10 +7,12 @@ their tags. The principal is as follow: * All the ticket with the tag ``roadmap`` will show up on the roadmap page. + * For each milestones defined in the settings of the project, the roadmap -will group tickets with the corresponding tag. + will group tickets with the corresponding tag. + * Tickets with the tag ``roadmap`` that are not associated with any of the -milestones defined in the settings are group in an ``unplanned`` section. + milestones defined in the settings are group in an ``unplanned`` section. Example @@ -21,12 +23,12 @@ For a project named ``test`` on ``pagure.io``. * First, go to the settings page of the project, create the milestones you -like, for example: ``v1.0`` and ``v2.0``. + like, for example: ``v1.0`` and ``v2.0``. * For the tickets you want to be on these milestones, go through each of them -and add them the tags: ``roadmap`` in combination with the milestone you want -``v1.0`` or ``v2.0``, or none of them if the ticket is on the roadmap but -not assigned to any milestones. + and add them the tags: ``roadmap`` in combination with the milestone you want + ``v1.0`` or ``v2.0``, or none of them if the ticket is on the roadmap but + not assigned to any milestones. * And this is how it will look like diff --git a/doc/usage/theming.rst b/doc/usage/theming.rst index 961b4ab..3e7b78e 100644 --- a/doc/usage/theming.rst +++ b/doc/usage/theming.rst @@ -78,4 +78,4 @@ flask here, ie: search in one folder and if you don't find the file look in another one. `An example apache configuration `_ -is provided as part of the sources of `flask-multistatic `_. +is provided as part of the sources of `flask-multistatic`_.