summaryrefslogtreecommitdiff
path: root/docs/contributing/documentation.rst
diff options
context:
space:
mode:
authorChristian Poessinger <christian@poessinger.com>2019-12-30 13:36:56 +0100
committerChristian Poessinger <christian@poessinger.com>2019-12-30 13:36:56 +0100
commit0567858714bc3306ac09aba2c167268a30e29d2b (patch)
tree1f7f6a98cabf8d3719e864e5c3872b051bbb58e1 /docs/contributing/documentation.rst
parent3a8e3b1e9c392b37eebbf1d3927965c4e4e2aa72 (diff)
downloadvyos-documentation-0567858714bc3306ac09aba2c167268a30e29d2b.tar.gz
vyos-documentation-0567858714bc3306ac09aba2c167268a30e29d2b.zip
documentation: add new custom command: vytask
Diffstat (limited to 'docs/contributing/documentation.rst')
-rw-r--r--docs/contributing/documentation.rst11
1 files changed, 11 insertions, 0 deletions
diff --git a/docs/contributing/documentation.rst b/docs/contributing/documentation.rst
index 1cf93313..5714fb00 100644
--- a/docs/contributing/documentation.rst
+++ b/docs/contributing/documentation.rst
@@ -186,6 +186,17 @@ descriptive way in the resulting HTML/PDF manual.
Display all known ARP table entries spanning accross all interfaces
+vytask
+""""""
+
+When referencing to VyOS Phabricator Tasks, there is a custom Spinx Markup
+command called ``vytask`` which automatically reners to a proper Phabricator
+URL. This is heavily used in the :ref:`release-notes` section.
+
+.. code-block:: none
+
+ * :vytask:`T1605` Fixed regression in L2TP/IPsec server
+ * :vytask:`T1613` Netflow/sFlow captures IPv6 traffic correctly
.. _Sphinx-doc: https://www.sphinx-doc.org