From: Aleš <ales.mrazek@nic.cz>
Date: Tue, 4 Jan 2022 20:27:40 +0000 (+0100)
Subject: docs: structuring documentation into sections
X-Git-Tag: v6.0.0a1~67
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=a0000e0c77ccba809f2168a956a2b0696a61df53;p=thirdparty%2Fknot-resolver.git

docs: structuring documentation into sections
---

diff --git a/manager/docs/configuration.rst b/manager/docs/configuration.rst
deleted file mode 100644
index 55f9f3f7e..000000000
--- a/manager/docs/configuration.rst
+++ /dev/null
@@ -1,44 +0,0 @@
-*************************
-Declarative configuration
-*************************
-
-.. contents::
-    :depth: 2
-    :local:
-
-Final documentation will be generated from configuration datamodel.
-This is just a raw proposal.
-
-server
-======
-
-.. envvar:: server:hostname: <str>
-
-    Detailed information probably from python docstring.
-
-network
-=======
-
-.. envvar:: network:interfaces: <list>
-
-    .. envvar:: listen: <ip-address>[@port]
-
-    .. envvar:: kind: <dns|xdp|dot|doh|control>
-
-        :default: dns
-
-    .. envvar:: freebind: <bool>
-
-        :default: false
-
-    Example:
-
-    .. code-block:: yaml
-
-        network:
-            interfaces:
-              - listen: eth0@53
-
-
-
-
diff --git a/manager/docs/index.rst b/manager/docs/index.rst
index db8f7220d..a654dee0f 100644
--- a/manager/docs/index.rst
+++ b/manager/docs/index.rst
@@ -6,8 +6,10 @@ Knot Resolver Manager
     :maxdepth: 2
     :caption: Manager:
 
-    getting-started
-    configuration
+    manager-introduction
+    manager-getting-started
+    manager-migration
+    manager-configuration
 
 ==================
 Indices and tables
diff --git a/manager/docs/manager-configuration.rst b/manager/docs/manager-configuration.rst
new file mode 100644
index 000000000..9b6731d67
--- /dev/null
+++ b/manager/docs/manager-configuration.rst
@@ -0,0 +1,3 @@
+*************
+Configuration
+*************
diff --git a/manager/docs/getting-started.rst b/manager/docs/manager-getting-started.rst
similarity index 61%
rename from manager/docs/getting-started.rst
rename to manager/docs/manager-getting-started.rst
index 6c6f84a01..9c15309a5 100644
--- a/manager/docs/getting-started.rst
+++ b/manager/docs/manager-getting-started.rst
@@ -1,16 +1,13 @@
 ***************
-Getting started
+Getting Started
 ***************
 
 .. contents::
     :depth: 1
     :local:
 
-Introduction
+Installation
 ============
 
-How to use
+Management
 ==========
-
-Migration
-=========
diff --git a/manager/docs/manager-introduction.rst b/manager/docs/manager-introduction.rst
new file mode 100644
index 000000000..ad6540ea0
--- /dev/null
+++ b/manager/docs/manager-introduction.rst
@@ -0,0 +1,3 @@
+************
+Introduction
+************
diff --git a/manager/docs/manager-migration.rst b/manager/docs/manager-migration.rst
new file mode 100644
index 000000000..1e4a0e780
--- /dev/null
+++ b/manager/docs/manager-migration.rst
@@ -0,0 +1,3 @@
+*********
+Migration
+*********