Document our JIRA integration extension

Provide a reference on how to use the extension.

Change-Id: I37716be4ca28fd84b50d1588fe9361a84ff5caec
Signed-off-by: Robert Varga <robert.varga@pantheon.tech>

diff --git a/docs/documentation.rst b/docs/documentation.rst
index 74b11d5facb74f6a3fd654924cdfa5eee0e3a06e..2e427b15a9ca7ec9789f5970dd504cfbdce2d91e 100644 (file)
--- a/docs/documentation.rst
+++ b/docs/documentation.rst
@@ -343,6 +343,23 @@ Because the labels have to be unique, a best practice is to prefix
 the labels with the project name to help share the label space; for example,
 use ``sfc-user-guide`` instead of just ``user-guide``.
 
+Referencing JIRA issues
+^^^^^^^^^^^^^^^^^^^^^^^
+
+In order to reference JIRA, we provide two new directives, ``jira_fixed_issues`` and
+``jira_known_issues``. These render a table of issues for a particular project and
+its version range. These are used like this:
+
+ .. code-block:: rst
+
+    .. jira_fixed_issues::
+       :project: CONTROLLER
+       :versions: 4.0.0-4.0.3
+
+    .. jira_known_issues::
+       :project: CONTROLLER
+       :versions: 4.0.0-4.0.3
+
 
 .. _docs-rst-troubleshooting:
 

diff --git a/docs/ext/README.md b/docs/ext/README.md
deleted file mode 100644 (file)
index a7b18f3..0000000
--- a/docs/ext/README.md
+++ /dev/null
@@ -1,3 +0,0 @@
-Sphinx extensions
-
-TODO: add proper linking