Blame doc/usage/roadmap.rst

Pierre-Yves Chibon f6c7d8
Using the roadmap feature
Pierre-Yves Chibon f6c7d8
=========================
Pierre-Yves Chibon f6c7d8
Pierre-Yves Chibon f6c7d8
Pagure allows building the roadmap of the project using the tickets and
Pierre-Yves Chibon f6c7d8
their tags.
Pierre-Yves Chibon f6c7d8
Pierre-Yves Chibon f6c7d8
The principal is as follow:
Pierre-Yves Chibon f6c7d8
Pierre-Yves Chibon 633465
* All the ticket with the tag ``roadmap`` will show up on the roadmap page.
Pierre-Yves Chibon 918dfa
Pierre-Yves Chibon f6c7d8
* For each milestones defined in the settings of the project, the roadmap
Pierre-Yves Chibon 918dfa
  will group tickets with the corresponding tag.
Pierre-Yves Chibon 918dfa
Pierre-Yves Chibon 633465
* Tickets with the tag ``roadmap`` that are not associated with any of the
Pierre-Yves Chibon 918dfa
  milestones defined in the settings are group in an ``unplanned`` section.
Pierre-Yves Chibon 633465
Pierre-Yves Chibon 633465
Pierre-Yves Chibon 633465
Example
Pierre-Yves Chibon 633465
-------
Pierre-Yves Chibon 633465
Pierre-Yves Chibon 633465
For a project named ``test`` on ``pagure.io``.
Pierre-Yves Chibon 633465
Pierre-Yves Chibon 633465
Pierre-Yves Chibon 633465
Pierre-Yves Chibon 633465
* First, go to the settings page of the project, create the milestones you
Pierre-Yves Chibon 918dfa
  like, for example: ``v1.0`` and ``v2.0``.
Pierre-Yves Chibon 633465
Pierre-Yves Chibon 633465
* For the tickets you want to be on these milestones, go through each of them
Pierre-Yves Chibon 918dfa
  and add them the tags: ``roadmap`` in combination with the milestone you want
Pierre-Yves Chibon 918dfa
  ``v1.0`` or ``v2.0``, or none of them if the ticket is on the roadmap but
Pierre-Yves Chibon 918dfa
  not assigned to any milestones.
Pierre-Yves Chibon 633465
Pierre-Yves Chibon 633465
Pierre-Yves Chibon 633465
* And this is how it will look like
Pierre-Yves Chibon 633465
Pierre-Yves Chibon 633465
.. image:: _static/pagure_roadmap2.png
Pierre-Yves Chibon 633465
        :target: _static/pagure_roadmap2.png