Skip to content

Add the ISC DNSSEC Guide as a BIND 9 ARM appendix

Michał Kępień requested to merge 606-add-the-isc-dnssec-guide-as-a-bind-9-arm-appendix into main

See #606 (closed) for prior discussion on the subject.

A preview of the end result can be found here:

https://bind9.readthedocs.io/en/606-add-the-isc-dnssec-guide-as-a-bind-9-arm-appendix/dnssec-guide.html

Here is what happens in this MR:

  • 0fd582c2 imports the required source files for the guide verbatim,

  • eedefa13 updates BIND's automated copyright checks to account for the files added in the previous commit,

  • 1c06e0f7 adds the standard copyright header to all the added *.rst files,

  • fab1d740 replaces the guide's own index.rst with a "subindex" file inside the BIND 9 ARM that allows the DNSSEC Guide to be processed as an appendix to the ARM; this also flattens the guide's structure (which matches what we do for e.g. the man pages appendix),

  • 0ca87359 "lowers" the header level for all headers in the DNSSEC Guide so that the guide's headers end up in the correct place in the ARM's chapter hierarchy,

  • 2aac168a fixes image paths so that Sphinx can embed them into the guide correctly,

  • ec0cd49e fixes references - flattening the document requires references to be unique, but fortunately reStructuredText supports auto-numbered footnote references, so this was easy to amend,

  • 05746d4a addresses reStructuredText reference clashes between the BIND 9 ARM and the DNSSEC Guide.

I think it would be okay to just squash all commits into a single one when this MR is signed off on.

Closes #606 (closed)

Edited by Michał Kępień

Merge request reports