From 23b2dad9d65d1d19869734d245eb272c08ae0460 Mon Sep 17 00:00:00 2001 From: =?utf8?q?Ale=C5=A1=20Mr=C3=A1zek?= Date: Tue, 14 Feb 2023 02:11:03 +0100 Subject: [PATCH] doc: gettingstarted: minor modifications - startup: link to Usage without the manager - config: json-schema mention moved to config-overview --- doc/config-overview.rst | 8 +++++++- doc/gettingstarted-config.rst | 6 ------ doc/gettingstarted-startup.rst | 8 ++++++-- 3 files changed, 13 insertions(+), 9 deletions(-) diff --git a/doc/config-overview.rst b/doc/config-overview.rst index 0e1b222df..f90719d14 100644 --- a/doc/config-overview.rst +++ b/doc/config-overview.rst @@ -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 `_ 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 `_. diff --git a/doc/gettingstarted-config.rst b/doc/gettingstarted-config.rst index bb9d07fa6..04d0f67b9 100644 --- a/doc/gettingstarted-config.rst +++ b/doc/gettingstarted-config.rst @@ -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 `_. 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 `_ 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 `_. - ========== Validation ========== diff --git a/doc/gettingstarted-startup.rst b/doc/gettingstarted-startup.rst index 190eacce9..7593aa142 100644 --- a/doc/gettingstarted-startup.rst +++ b/doc/gettingstarted-startup.rst @@ -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 ` section. +If you have this problem, look at :ref:`usage without 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 ` + Otherwise, it is recommended to stick to this chapter. =============== First DNS query -- 2.47.3