]> git.ipfire.org Git - thirdparty/knot-resolver.git/commitdiff
doc: fix links
authorVasek Sraier <git@vakabus.cz>
Mon, 9 Jan 2023 22:20:12 +0000 (23:20 +0100)
committerVasek Sraier <git@vakabus.cz>
Tue, 10 Jan 2023 19:20:57 +0000 (20:20 +0100)
doc/config-overview.rst
doc/config-schema.rst
doc/manager-api.rst

index a4be867caa092a05f87a92827d41d31b64b385d1..0e1b222df3d314ef7108d1b48c37d0fd98c9887a 100644 (file)
@@ -12,8 +12,8 @@ Different configuration file can be loaded by using command line option
 Syntax
 ======
 
-The configuration file uses `YAML format version 1.1 <https://yaml.org/spec/1.1/>_`.
-To quickly learn about the format, you can have a look at `Learn YAML in Y minutes <https://learnxinyminutes.com/docs/yaml/>_`.
+The configuration file uses `YAML format version 1.1 <https://yaml.org/spec/1.1/>`_.
+To quickly learn about the format, you can have a look at `Learn YAML in Y minutes <https://learnxinyminutes.com/docs/yaml/>`_.
 
 
 Schema
index 25b92c4cc8659114f49eb8d1e5939ad3e6d9bfbb..769587d26bff7be0ccd6b979bab47c8d58a091d3 100644 (file)
@@ -2,14 +2,14 @@ Configuration schema
 ====================
 
 
-The configuration schema describes the structure of accepted configuration files (or objects via the API). While originally specified in Python source code, it can be visualized as a `JSON schema <https://json-schema.org/>_`.
+The configuration schema describes the structure of accepted configuration files (or objects via the API). While originally specified in Python source code, it can be visualized as a `JSON schema <https://json-schema.org/>`_.
 
 Getting the JSON schema
 -----------------------
 
 1. The JSON schema can be obtained from a running Resolver by sending a HTTP GET request to the path ``/schema`` on the management socket (by default a Unix socket at ``/var/run/knot-resolver/manager.sock``).
 2. The ``kresctl schema`` command outputs the schema of the currently installed version as well. It does not require a running resolver.
-3. JSON schema for the most recent Knot Resolver version can be `downloaded here <_static/config.schema.json>_`.
+3. JSON schema for the most recent Knot Resolver version can be `downloaded here <_static/config.schema.json>`_.
 
 Validating you configuration
 ----------------------------
index 29f5fb8f1d43cd83731e2c1c0c7ba18480053811..592710903129a848f5a6ecfaa44cb977d9eee5a6 100644 (file)
@@ -52,6 +52,9 @@ HTTP request methods               Operation
     In the case of an attempt to configure such an option, the operation is rejected.
 
 
+-----------------------------------
+
+
 
 
 ===================================
@@ -102,7 +105,7 @@ The different HTTP methods perform different modifications of the configuration:
 - ``GET`` return subtree of the current configuration
 - ``PUT`` set property
 - ``DELETE`` removes the given property or list item at the given index
-- ``PATCH`` updates the configuration using `JSON Patch <https://jsonpatch.com/>_`
+- ``PATCH`` updates the configuration using `JSON Patch <https://jsonpatch.com/>`_
 
 To prevent race conditions when changing configuration from multiple clients simultaneously, every response from the Manager has an ``ETag`` header set. Requests then accept ``If-Match`` and ``If-None-Match`` headers with the latest ``ETag`` value and the corresponding request processing fails with HTTP error code 412 (precondition failed).