doc: add Quick Reference section to User guide

diff --git a/doc/index.rst b/doc/index.rst
index 45d7c8f970fb469a0b84602d1fb2d0d702526ef2..b8b56ccec25750e0f9763c00612669873672ac38 100644 (file)
--- a/doc/index.rst
+++ b/doc/index.rst
@@ -11,6 +11,7 @@ and it provides a state-machine like API for extensions.
    :name: users
    :maxdepth: 2
 
+   quickref
    daemon
    modules
 

diff --git a/doc/quickref.rst b/doc/quickref.rst
new file mode 100644 (file)
index 0000000..9ef2750
--- /dev/null
+++ b/doc/quickref.rst
@@ -0,0 +1,8 @@
+***************
+Quick Reference
+***************
+
+* `Installation <https://www.knot-resolver.cz/download/>`_
+* :ref:`TLS Forwarding <tls-forwarding>`
+* :ref:`network-configuration`
+* :ref:`Module: policy <mod-policy>`

diff --git a/modules/policy/README.rst b/modules/policy/README.rst
index d71efe556fe7fb5a760b9b51164f7f84ff8ccb81..77ce89700ba37a859af38f73772950c087403d56 100644 (file)
--- a/modules/policy/README.rst
+++ b/modules/policy/README.rst
@@ -75,6 +75,8 @@ Also, it is possible to write your own action (i.e. Lua function). It is possibl
 
 .. note:: The module (and ``kres``) expects domain names in wire format, not textual representation. So each label in name is prefixed with its length, e.g. "example.com" equals to ``"\7example\3com"``. You can use convenience function ``todname('example.com')`` for automatic conversion.
 
+.. _tls-forwarding:
+
 Forwarding over TLS protocol (DNS-over-TLS)
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 Policy `TLS_FORWARD` allows you to forward queries using `Transport Layer Security`_ protocol, which hides the content of your queries from an attacker observing the network traffic. Further details about this protocol can be found in :rfc:`7858` and `IETF draft dprive-dtls-and-tls-profiles`_.