From: Vasek Sraier <git@vakabus.cz>
Date: Sun, 8 Jan 2023 22:04:15 +0000 (+0100)
Subject: docs: moved old lua configuration to section "advanced configuration"
X-Git-Tag: v6.0.0a1~11^2~2
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=f758d1e2b52c7cfb1bd98e9d6d8e4167cdcceb58;p=thirdparty%2Fknot-resolver.git

docs: moved old lua configuration to section "advanced configuration"
---

diff --git a/doc/config-lua-overview.rst b/doc/config-lua-overview.rst
index 35d667a9e..d5316c044 100644
--- a/doc/config-lua-overview.rst
+++ b/doc/config-lua-overview.rst
@@ -1,6 +1,3 @@
-
-
-
 .. _config-syntax:
 
 Syntax
diff --git a/doc/config-lua.rst b/doc/config-lua.rst
new file mode 100644
index 000000000..bcdf2feee
--- /dev/null
+++ b/doc/config-lua.rst
@@ -0,0 +1,23 @@
+
+Advanced configuration (Lua)
+============================
+
+Knot Resolver can be configured declaratively by using YAML files or YAML/JSON HTTP API. However, there is another option. The actual worker processes (the ``kresd`` executable) speaks a different configuration language, it internally uses the Lua runtime and the respective programming language.
+
+Essentially, the declarative configuration is only used for validation and as an external interface. After validation, a Lua configuration is generated and passed into individual ``kresd`` instances. You can see the generated configuration files within the Resolver's working directory or you can manually run the conversion of declarative configuration with the ``kresctl convert`` command.
+
+.. warning::
+        While there are no plans of ever removing the Lua configuration, we do not guarantee absence of backwards incompatible changes. Starting with Knot Resolver version 6 and later, we consider the Lua interface internal and a subject to change. While we don't have any breaking changes planned for the foreseeable future, they might come.
+
+        **Therefore, use this only when you don't have any other option. And please let us know about it and we might try to accomodate your usecase in the declarative configuration.**
+
+.. toctree::
+   :maxdepth: 2
+   
+   config-lua-overview
+   config-network
+   config-performance
+   config-policy
+   config-logging-monitoring
+   config-dnssec
+   config-experimental
\ No newline at end of file
diff --git a/doc/index.rst b/doc/index.rst
index 4c5f4944b..5c2ccb0eb 100644
--- a/doc/index.rst
+++ b/doc/index.rst
@@ -48,13 +48,8 @@ and it provides a state-machine like API for extensions.
 
    config-overview
    config-schema
-   config-network
-   config-performance
-   config-policy
-   config-logging-monitoring
-   config-dnssec
-   config-experimental
    config-no-systemd
+   config-lua
 
 
 .. toctree::