From b2df3ff9a1befdebc2750ddc83d2ea940344d731 Mon Sep 17 00:00:00 2001 From: Pierre-Yves Chibon Date: May 09 2016 09:55:42 +0000 Subject: [PATCH 1/3] Move the images into a sub folder of the `usage` section --- diff --git a/doc/_static/pagure_custom_pr.png b/doc/_static/pagure_custom_pr.png deleted file mode 100644 index 5086d23..0000000 Binary files a/doc/_static/pagure_custom_pr.png and /dev/null differ diff --git a/doc/_static/pagure_my_settings.png b/doc/_static/pagure_my_settings.png deleted file mode 100644 index d7fb5c7..0000000 Binary files a/doc/_static/pagure_my_settings.png and /dev/null differ diff --git a/doc/_static/pagure_ticket_template.png b/doc/_static/pagure_ticket_template.png deleted file mode 100644 index 3153907..0000000 Binary files a/doc/_static/pagure_ticket_template.png and /dev/null differ diff --git a/doc/usage/_static/pagure_custom_pr.png b/doc/usage/_static/pagure_custom_pr.png new file mode 100644 index 0000000..5086d23 Binary files /dev/null and b/doc/usage/_static/pagure_custom_pr.png differ diff --git a/doc/usage/_static/pagure_my_settings.png b/doc/usage/_static/pagure_my_settings.png new file mode 100644 index 0000000..d7fb5c7 Binary files /dev/null and b/doc/usage/_static/pagure_my_settings.png differ diff --git a/doc/usage/_static/pagure_ticket_template.png b/doc/usage/_static/pagure_ticket_template.png new file mode 100644 index 0000000..3153907 Binary files /dev/null and b/doc/usage/_static/pagure_ticket_template.png differ From 633465edc192d39e234e4719c7f4976b49bce7e7 Mon Sep 17 00:00:00 2001 From: Pierre-Yves Chibon Date: May 09 2016 09:55:42 +0000 Subject: [PATCH 2/3] Finish the roadmap documentation with an example --- diff --git a/doc/usage/_static/pagure_roadmap2.png b/doc/usage/_static/pagure_roadmap2.png new file mode 100644 index 0000000..a08114f Binary files /dev/null and b/doc/usage/_static/pagure_roadmap2.png differ diff --git a/doc/usage/roadmap.rst b/doc/usage/roadmap.rst index d4ec443..e1b7cd5 100644 --- a/doc/usage/roadmap.rst +++ b/doc/usage/roadmap.rst @@ -6,6 +6,30 @@ their tags. The principal is as follow: -* All the ticket with the tag ``roadmap`` will show up on the roadmap page +* 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. +* Tickets with the tag ``roadmap`` that are not associated with any of the +milestones defined in the settings are group in an ``unplanned`` section. + + +Example +------- + +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``. + +* 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 this is how it will look like + +.. image:: _static/pagure_roadmap2.png + :target: _static/pagure_roadmap2.png From 925611759e4e3e4bb7141143d111bfb2c31e8f0e Mon Sep 17 00:00:00 2001 From: Pierre-Yves Chibon Date: May 09 2016 09:55:42 +0000 Subject: [PATCH 3/3] Include the roadmap doc in the usage section of the doc --- diff --git a/doc/usage.rst b/doc/usage.rst index 09e7587..aee0095 100644 --- a/doc/usage.rst +++ b/doc/usage.rst @@ -34,6 +34,7 @@ Contents: usage/first_steps usage/project_settings + usage/roadmap usage/using_doc usage/using_webhooks usage/ticket_templates