Skip to content

Commit

Permalink
Add to-do
Browse files Browse the repository at this point in the history
  • Loading branch information
AlexanderBand committed Dec 12, 2021
1 parent 1ef4559 commit ed4f519
Show file tree
Hide file tree
Showing 2 changed files with 66 additions and 35 deletions.
44 changes: 9 additions & 35 deletions source/index.rst
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
.. Unbound User Manual master file
.. _doc_index:

Unbound by NLnet Labs
=====================
Expand All @@ -8,16 +8,15 @@ caching DNS resolver. It is designed to be fast and lean and incorporates modern
features based on open standards.

.. Note:: Do you love to write and know your way around DNS and Unbound?
Help us expand this documentation and we'll compensate you
for your time. Contact us at docs@nlnetlabs.nl or find us on
`Twitter <https://twitter.com/nlnetlabs>`_.
:ref:`Help us expand this documentation <doc_todo>` and we'll
compensate you for your time. Contact us at docs@nlnetlabs.nl or find
us on `Twitter <https://twitter.com/nlnetlabs>`_.

Unbound runs on FreeBSD, OpenBSD, NetBSD, MacOS, Linux and Microsoft Windows,
with packages available for most platforms. It is included in the base-system of
FreeBSD and OpenBSD and in the standard repositories of most Linux
distributions. Installation and configuration is designed to be easy. Setting up
a resolver for your machine or network can be done with only a few lines of
configuration.
with packages available for most platforms. It is included in the standard
repositories of most Linux distributions. Installation and configuration is
designed to be easy. Setting up a resolver for your machine or network can be
done with only a few lines of configuration.

This documentation is an open source project maintained by NLnet Labs. is edited
via text files in the `reStructuredText
Expand Down Expand Up @@ -49,21 +48,6 @@ license, with attribution to NLnet Labs.
use-cases/home-resolver
use-cases/local-stub

..
use-cases/enterprise-resolver
use-cases/isp-resolver
use-cases/privacy-aware-resolver
..
.. toctree::
:maxdepth: 2
:caption: Topics
topics/privacy/index
topics/filtering/index
topics/ecs
topics/resiliency

.. toctree::
:maxdepth: 2
:caption: Core
Expand All @@ -84,17 +68,6 @@ license, with attribution to NLnet Labs.

topics/filtering/tags-views
topics/filtering/rpz
..
.. toctree::
:maxdepth: 2
:caption: Internals
internals/python-modules
internals/server-selection
internals/compliance
internals/architecture
internals/code-structure
internals/trust-anchors

.. toctree::
:maxdepth: 2
Expand All @@ -121,6 +94,7 @@ license, with attribution to NLnet Labs.
:caption: Reference

reference/history/index
reference/todo


Indices and tables
Expand Down
57 changes: 57 additions & 0 deletions source/reference/todo.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,57 @@
.. _doc_todo:

Docs To-Do List
===============

Since the first release in 2007, the documentation of Unbound has been
maintained with a heavy focus on :ref:`manual pages<doc_unbound_manpage>`. As
the resolver has become more versatile and feature-rich over the years, the
NLnet Labs team decided to add this documention, providing installation guides
for different platforms, practical use cases, and background information.

The to-do list below provides and overview if the the topics we still have to
cover. If you feel something is missing, please `open an issue on GitHub
<https://github.com/NLnetLabs/unbound-manual/issues>`_ to let us know.

.. Note:: If you would like to write one or more of these pages, we're happy to
compensate you for your time. Contact us at docs@nlnetlabs.nl or find
us on `Twitter <https://twitter.com/nlnetlabs>`_.

Use Cases
---------

- Resolver setup for enterprise networks
- Resolver setup for ISPs
- Maximum privacy resolver

Topics
------

- ECS
- Resiliency
- Rate Limiting
- ACLs
- EDNS Client Subnet

Filtering and Manipulating Data
-------------------------------

- Local Zones and Local Data
- Expansion to all RPZ triggers and actions

Privacy
-------

- Auth Zone
- Encryption
- QNAME Minimisation

Internals
---------

- Architecture
- Code structure
- Compliance
- Server selection
- Trust Anchors
- Python modules

0 comments on commit ed4f519

Please sign in to comment.