Skip to content

docs: new sphinx documentation and its structure

This issue is intended as a space for discussion about structure and content of the new sphinx documentation.

New top level sections

Sections do not differ much from the original ones, rather the name is slightly modified for consistency or better naming of the content inside.

  • GETTING STARTED
    • The resolver introduction (manager introduction and its (dis)advantages)
    • Installation from packages
    • The resolver systemd startup with manager and legacy daemon. First DNS query(kdig).
    • Configuration: YAML config file, management API, kresctl utility, legacy Lua
  • COMMON USE CASES
    • The resolver common use cases with configuration and related info.
    • Perhaps some guides HTTP API, kresctl, no-systemd, ansible, etc... (It would require better name for the section.)
  • CONFIGURATION
    • Structure will be very similar to the current except for added YAML configuration using sphinx-tabs. Mayme it will be slightly modified in favor of the new declarative configuration schema.
  • FOR OPERATORS
    • Information for users who already operate the resolver.
    • upgrading guides, 5.x -> 6.0, release notes, ...
  • FOR DEVELOPERS
    • Information for developers and advanced users (lib, lua modules, Lua stuff)
    • Building from source (apkg, meson, doc)

Related comments:

Edited by Aleš Mrázek
To upload designs, you'll need to enable LFS and have an admin enable hashed storage. More information