From 8d07f25bb504e2465c7e8ba1bdeda035a20ae8cb Mon Sep 17 00:00:00 2001
From: Pierre-Yves Chibon <pingou@pingoured.fr>
Date: Mar 11 2016 16:50:28 +0000
Subject: Add documentation on how to create templates for tickets


---

diff --git a/doc/_static/pagure_ticket_template.png b/doc/_static/pagure_ticket_template.png
new file mode 100644
index 0000000..3153907
Binary files /dev/null and b/doc/_static/pagure_ticket_template.png differ
diff --git a/doc/ticket_templates.rst b/doc/ticket_templates.rst
new file mode 100644
index 0000000..aac6518
--- /dev/null
+++ b/doc/ticket_templates.rst
@@ -0,0 +1,77 @@
+Templates for ticket input
+==========================
+
+Pagure offers the possibility to add templates for ticket's input. These
+templates do not enforce anything, users will have the possibility to simply
+ignore it, or even to not follow it, but it also helps structuring the
+ticket opened against a project and highlighting the information that are
+often requested/needed.
+
+The templates are providing in the git repository containing the meta-data
+for the tickets.
+They must be placed under a ``templates`` folder in this git repository,
+end with ``.md``and as the extension suggests can be formated as markdown.
+
+If you create a template ``templates/default.md``, it will be shown by
+default when someone ask to create a new ticket.
+
+
+
+Example
+-------
+
+For a project named ``test`` on ``pagure.io``.
+
+* First, clone the ticket git repo [#f1]_ and move into it
+
+::
+
+    git clone ssh://git@pagure.io/tickets/pagure.git
+    cd test
+
+* Create the templates folder
+
+::
+
+    mkdir templates
+
+* Create a default template
+
+::
+
+    vim templates/default.md
+
+And place in this file the following content:
+
+::
+
+    ##### Issue
+
+    ##### Steps to reproduce
+    1.
+    2.
+    3.
+
+    ##### Actual results
+
+    ##### Expected results
+
+* Commit and push the changes to the git repo
+
+::
+
+    git add templates
+    git commit -m "Add a default template for tickets"
+    git push
+
+
+* And this is how it will look like
+
+.. image:: _static/pagure_ticket_template.png
+        :target: _static/pagure_ticket_template.png
+
+
+
+.. [#f1] All the URLs to the different git repositories can be found on the
+         main page of the project, on the right-side menu, under the section
+         ``Source GIT URLs``, click on ``more`` to see them.
diff --git a/doc/usage.rst b/doc/usage.rst
index 6253d99..ec62a02 100644
--- a/doc/usage.rst
+++ b/doc/usage.rst
@@ -11,3 +11,4 @@ Contents:
    :maxdepth: 2
 
    theming
+   ticket_templates