Skip to content

Fine tune the documentation

Tasks

  • Re-structure docs according to Diatáxis, or at least split some content between How-To Guides and Tutorials.
  • Do a more fine-grained edit in the docs, including:
    • Survival Guide (EOTK portion).
    • Migration guide for those coming from EOTK, replacing the migration sketched in the ChangeLog (basically copying all .conf, .tconf, secrets; building and configuring; copying the certificates).
    • Improved introduction:
      • Project description.
      • What it does: adds Onion Service support for existing sites.
      • Overview how it works (rewriting proxy through .onion) (with a diagram). The proxy is mainly intended to replace regular domain names with their .onion counterparts, offering a seamless experience to users.
      • How it's usually installed: no need to changing existing setups, just provision the Onion Services infra in parallel of existing setups; can run anywhere, in a laptop, a single board computer, in servers; as standalone program, or as a container.
      • Use-cases.
    • On EOTK compatibility: the eotk script is kept as an alias to onionspray.
    • Replace eotk with onionspray in the CLI usage.
  • Installation:
    • Required knowledge (Onion Services and command line familiarity etc).
    • Using Tor and OpenResty upstream packages for your distro (when available) (moved to #21 (closed)).
  • Contact and reporting:
    • Contact info (tor-dev channel and mailing list?).
    • How to report bugs.
  • ChangeLog:
  • Setup the Renovate Bot to watch for changes in vendorized Git submodules.
  • Review the documentation.

Time estimation

  • Complexity: very small (0.5 day)
  • Uncertainty: low (x1.1)
  • Reference (adapted)
Edited by Silvio Rhatto