upstream/bind9
1
0
Fork 0
mirror of https://github.com/isc-projects/bind9.git synced 2026-03-17 08:03:44 -04:00
Code Issues Projects Releases Packages Wiki Activity Actions
bind9/doc/arm
History
Petr Špaček 833af31e7b
ARM style change: render literals in black color 
After enormous amount of bikesheding about colors we decided to override
ReadTheDocs default style for literals (``literal`` in the RST markup).

Justification:
- The default RTD "light red literal on white background" is hard to
  read.  https://webaim.org/resources/contrastchecker/ reports that text
  colored as rgb(231, 76, 60) on white background has insufficient
  contrast.
- The ARM has enormous amount of literals all over the place and thus
  one sentence can contain several black/red/black color changes. This
  is distracting. As a consequence, the ARM looks like a Geronimo
  Stilton book.

What we experimented with as replacements for red:
- Green - way too distracting
- Blue - too similar to "usual clickable link"
- Violet - too Geronimo Stilton style
- Brown - better but still distracting

After all the bikesheding we settled on black, i.e. the same as all
"normal" text. I.e. the color is now the same and literals are denoted
by monospaced font and a box around the literal. This has best contrast
and is way less distracting than it used to be.

This lead to a new problem: Internal references to "term definitions"
defined using directives like .. option:: were rendered almost the same
as literals:
- References: monospaced + box + bold + clickable
- Literals: monospaced + box To distinguish these two we added black
  dotted underline to clickable references.

I hereby declare the bikeshed painted.
2022-06-02 17:13:19 +02:00
..
_static ARM style change: render literals in black color 2022-06-02 17:13:19 +02:00
.gitattributes make git aware XML docbooks are only asset ARM needs to track 2020-01-13 11:08:18 +01:00
.gitignore Convert the documentation to Sphinx documentation format 2020-05-07 16:02:56 +02:00
advanced.inc.rst Split chapter Advanced DNS Features in the ARM into chapters 5, 6, 7 2022-05-11 10:51:26 +02:00
build.inc.rst Remove build from chapter 2 and move it to the end of ARM 2022-05-11 10:51:26 +02:00
catz.inc.rst Restructure includes for ARM chapters 1 (Intro) and 2 (Requirements) 2022-05-11 10:51:21 +02:00
chapter1.rst Rewrite Introduction chapters of the ARM 2022-05-11 10:51:26 +02:00
chapter2.rst Remove build from chapter 2 and move it to the end of ARM 2022-05-11 10:51:26 +02:00
chapter3.rst Rewrite Configurations and Zone Files section in the ARM 2022-05-11 10:51:26 +02:00
chapter4.rst Split Configuration chapter in the ARM into chapters 3 and 4 2022-05-11 10:51:26 +02:00
chapter5.rst Add RPZ section to the ARM 2022-05-11 10:51:26 +02:00
chapter6.rst Split chapter Advanced DNS Features in the ARM into chapters 5, 6, 7 2022-05-11 10:51:26 +02:00
chapter7.rst Split chapter Advanced DNS Features in the ARM into chapters 5, 6, 7 2022-05-11 10:51:26 +02:00
chapter9.rst Restructure includes for chapter 9 Troubleshooting 2022-05-11 10:51:26 +02:00
chapter10.rst Remove build from chapter 2 and move it to the end of ARM 2022-05-11 10:51:26 +02:00
conf.py Allow wrapping for ARM table content 2022-06-02 17:13:19 +02:00
config-auth.inc.rst Rewrite Configurations and Zone Files section in the ARM 2022-05-11 10:51:26 +02:00
config-intro.inc.rst Rewrite Configurations and Zone Files section in the ARM 2022-05-11 10:51:26 +02:00
config-resolve.inc.rst Rewrite Configurations and Zone Files section in the ARM 2022-05-11 10:51:26 +02:00
dlz.inc.rst Restructure includes for ARM chapters 1 (Intro) and 2 (Requirements) 2022-05-11 10:51:21 +02:00
dns-ops.inc.rst Split Configuration chapter in the ARM into chapters 3 and 4 2022-05-11 10:51:26 +02:00
dns-security-overview.dia Rewrite Introduction chapters of the ARM 2022-05-11 10:51:26 +02:00
dns-security-overview.png Rewrite Introduction chapters of the ARM 2022-05-11 10:51:26 +02:00
dns-servers.dia Rewrite Introduction chapters of the ARM 2022-05-11 10:51:26 +02:00
dns-servers.png Rewrite Introduction chapters of the ARM 2022-05-11 10:51:26 +02:00
dns-tree.dia Rewrite Introduction chapters of the ARM 2022-05-11 10:51:26 +02:00
dns-tree.png Rewrite Introduction chapters of the ARM 2022-05-11 10:51:26 +02:00
dnssec-guide.rst Minor DNSSEC guide tweaks 2022-05-11 10:51:26 +02:00
dnssec.inc.rst Split chapter Advanced DNS Features in the ARM into chapters 5, 6, 7 2022-05-11 10:51:26 +02:00
dyndb.inc.rst Restructure includes for ARM chapters 1 (Intro) and 2 (Requirements) 2022-05-11 10:51:21 +02:00
general.rst Hyperlink program names to their manual pages 2022-03-14 10:46:36 +01:00
history.rst Update the copyright information in all files in the repository 2022-01-11 09:05:02 +01:00
index.rst Restructure includes for chapter 9 Troubleshooting 2022-05-11 10:51:26 +02:00
intro-dns-bind.inc.rst Rewrite Introduction chapters of the ARM 2022-05-11 10:51:26 +02:00
intro-security.inc.rst Rewrite Introduction chapters of the ARM 2022-05-11 10:51:26 +02:00
introduction.inc.rst Rewrite Introduction chapters of the ARM 2022-05-11 10:51:26 +02:00
isc-logo.pdf Update ISC logo 2020-07-08 02:00:11 +00:00
logging-categories.inc.rst Restructure includes for ARM chapters 1 (Intro) and 2 (Requirements) 2022-05-11 10:51:21 +02:00
Makefile.am Allow wrapping for ARM table content 2022-06-02 17:13:19 +02:00
managed-keys.inc.rst Split chapter Advanced DNS Features in the ARM into chapters 5, 6, 7 2022-05-11 10:51:26 +02:00
manpages.rst In the ARM appendix, sort man page sections alphabetically 2022-03-10 20:13:22 +01:00
name-resolution.dia Rewrite Introduction chapters of the ARM 2022-05-11 10:51:26 +02:00
name-resolution.png Rewrite Introduction chapters of the ARM 2022-05-11 10:51:26 +02:00
notes.rst BIND 9.19.1 2022-05-19 10:55:42 +02:00
pkcs11.inc.rst Split chapter Advanced DNS Features in the ARM into chapters 5, 6, 7 2022-05-11 10:51:26 +02:00
platforms.inc.rst Add new ARM section Installing BIND 9 2022-05-11 10:51:26 +02:00
plugins.inc.rst Split Configuration chapter in the ARM into chapters 3 and 4 2022-05-11 10:51:26 +02:00
primary-secondary.dia Rewrite Configurations and Zone Files section in the ARM 2022-05-11 10:51:26 +02:00
primary-secondary.png Rewrite Configurations and Zone Files section in the ARM 2022-05-11 10:51:26 +02:00
recursive-query.dia Rewrite Introduction chapters of the ARM 2022-05-11 10:51:26 +02:00
recursive-query.png Rewrite Introduction chapters of the ARM 2022-05-11 10:51:26 +02:00
reference.rst Update signatures-refresh documentation 2022-05-31 15:45:14 +02:00
requirements.inc.rst Change title and add extra link to Resource Requirements in the ARM 2022-05-11 10:51:26 +02:00
requirements.txt Pin Sphinx related package versions to match ReadTheDocs and our CI 2022-04-27 14:33:45 +02:00
resolver-forward.dia Rewrite Configurations and Zone Files section in the ARM 2022-05-11 10:51:26 +02:00
resolver-forward.png Rewrite Configurations and Zone Files section in the ARM 2022-05-11 10:51:26 +02:00
rpz.inc.rst Add RPZ section to the ARM 2022-05-11 10:51:26 +02:00
security.inc.rst Split chapter Advanced DNS Features in the ARM into chapters 5, 6, 7 2022-05-11 10:51:26 +02:00
sig0.inc.rst Split chapter Advanced DNS Features in the ARM into chapters 5, 6, 7 2022-05-11 10:51:26 +02:00
tkey.inc.rst Split chapter Advanced DNS Features in the ARM into chapters 5, 6, 7 2022-05-11 10:51:26 +02:00
troubleshooting.inc.rst Restructure includes for chapter 9 Troubleshooting 2022-05-11 10:51:26 +02:00
tsig.inc.rst Split chapter Advanced DNS Features in the ARM into chapters 5, 6, 7 2022-05-11 10:51:26 +02:00
zones.inc.rst Tweak zones.inc.rst now separated from Reference section 2022-05-11 10:51:26 +02:00