Skip to content
Snippets Groups Projects
Verified Commit a2246f45 authored by Oto Šťáva's avatar Oto Šťáva
Browse files

content/documentation: README and page

parent ba662258
1 merge request!125content/documentation: put docs in the tree
Pipeline #123867 passed with stage
in 16 seconds
# Documentation trees
When releasing a new version, download the artifacts ZIP generated by the
`docs:build` job in the Knot Resolver repo, extract the `doc/html` directory
from there into this directory and name it `v<VersionNumber>`. If that version
is considered stable, re-link the `stable` symlink to it as well.
......@@ -4,32 +4,40 @@
:lang: en
:menuorder: 2
.. The inconsistency in links (sometimes absolute and sometimes relative) is
here beceuase 'stable' is a symlink in this repo, while 'latest' is
reverse-proxied to GitLab Pages by our frontend server, and thus is not
available locally.
Quickstart
==========
1. `Install packages <https://knot-resolver.readthedocs.io/en/stable/quickstart-install.html>`_
2. `Run daemon <https://knot-resolver.readthedocs.io/en/stable/quickstart-startup.html>`_
1. `Install packages <stable/quickstart-install.html>`_
2. `Run daemon <stable/quickstart-startup.html>`_
Knot Resolver is now running on localhost and will recursively resolve any
incoming queries. Now you can query it or `play with its configuration <https://knot-resolver.readthedocs.io/en/stable/quickstart-config.html>`_.
incoming queries. Now you can query it or `play with its configuration <stable/quickstart-config.html>`_.
Comprehensive documentation
===========================
Docs for stable version are available online at
`knot-resolver.readthedocs.org <https://knot-resolver.readthedocs.org/en/stable>`__.
Docs for the latest stable version 5 are available online at
`knot-resolver.cz/documentation/stable <stable>`__.
Docs for the latest early-access version 6.0.x are available online at
`knot-resolver.cz/documentation/latest <https://knot-resolver.cz/documentation/latest>`__
Offline documentation is also available in *knot-resolver-doc* package for most
distributions.
*Read the Docs* also offers downloads of
`PDF <https://readthedocs.org/projects/knot-resolver/downloads/pdf/stable/>`__
and
`EPUB <https://readthedocs.org/projects/knot-resolver/downloads/epub/stable/>`__
formats for viewing offline.
.. *Read the Docs* also offers downloads of
`PDF <https://readthedocs.org/projects/knot-resolver/downloads/pdf/stable/>`__
and
`EPUB <https://readthedocs.org/projects/knot-resolver/downloads/epub/stable/>`__
formats for viewing offline.
Upgrading
=========
Occasionally a major version release might require a manual upgrade.
Please refer to
`Upgrading Guide <https://knot-resolver.readthedocs.io/en/stable/upgrading.html>`_.
`Upgrading Guide <stable/upgrading.html>`_.
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment