]> git.ipfire.org Git - thirdparty/knot-resolver.git/commitdiff
doc: gettingstarted: minor modifications
authorAleš Mrázek <ales.mrazek@nic.cz>
Tue, 14 Feb 2023 01:11:03 +0000 (02:11 +0100)
committerAleš Mrázek <ales.mrazek@nic.cz>
Mon, 5 Jun 2023 13:34:21 +0000 (15:34 +0200)
- startup: link to Usage without the manager
- config: json-schema mention moved to config-overview

doc/config-overview.rst
doc/gettingstarted-config.rst
doc/gettingstarted-startup.rst

index 0e1b222df3d314ef7108d1b48c37d0fd98c9887a..f90719d14622bae3685c18a8b7eafebe2981749d 100644 (file)
@@ -31,6 +31,12 @@ checks for conformance to our :ref:`configuration-schema`.
         ERROR:knot_resolver_manager.server:multiple configuration errors detected:
                 [/management/interface] invalid port number 66000
                 [/logging/level] 'noticed' does not match any of the expected values ('crit', 'err', 'warning', 'notice', 'info', 'debug')
-    
+
     If you happen to find a rejected configuration with unhelpful or confusing error message, please report it as a bug.
 
+
+.. tip::
+
+    An easy way to see the complete configuration structure is to look at the `JSON schema <https://json-schema.org/>`_ represention.
+    The raw JSON schema is available at `this link <_static/config.schema.json>`_ (valid only for the version of resolver this documentation was generated for).
+    For the schema readability, some graphical visualizer can be used, for example `this one <https://json-schema.app/>`_.
index bb9d07fa6b3d9cf7a9b6feae42eabac2027b3679..04d0f67b956baa1e244c745a04639a585f51c20e 100644 (file)
@@ -37,12 +37,6 @@ You can also start exploring the configuration by reading about :ref:`common use
 Complete configurations files examples can be found `here <https://gitlab.nic.cz/knot/knot-resolver/tree/master/etc/config>`_.
 Examples are also installed as documentation files, typically in ``/usr/share/doc/knot-resolver/examples/`` directory (location may be different based on your Linux distribution).
 
-.. tip::
-
-    An easy way to see the complete configuration structure is to look at the `JSON schema <https://json-schema.org/>`_ represention.
-    The raw JSON schema is available at `this link <_static/config.schema.json>`_ (valid only for the version of resolver this documentation was generated for).
-    For the schema readability, some graphical visualizer can be used, for example `this one <https://json-schema.app/>`_.
-
 ==========
 Validation
 ==========
index 190eacce9727977945e16febe837f7afeb396f28..7593aa142862b8b1a976e136a961583597448fb2 100644 (file)
@@ -6,7 +6,7 @@
 Startup
 *******
 
-The best way to run Knot Resolver is to use provided integration with ``systemd``.
+The main way to run Knot Resolver is to use provided integration with ``systemd``.
 
 .. code-block:: bash
 
@@ -21,8 +21,12 @@ For more information about systemd integration see ``man knot-resolver.systemd``
     To start and enable service in one command use ``systemctl enable --now knot-resolver.service``
 
 Unfortunately, for some cases (typically Docker and minimalistic systems), ``systemd`` is not available, therefore it is not possible to use ``knot-resolver.service``.
-If you have this problem, look at :ref:`usage without systemd <manager-no-systemd>` section.
+If you have this problem, look at :ref:`usage without systemd <config-no-systemd>` section.
 
+.. note::
+
+    If for some reason you need to use Knot Resolver as it was before version 6, check out :ref:`usage without the manager <advanced-no-manager>`
+    Otherwise, it is recommended to stick to this chapter.
 
 ===============
 First DNS query