From b1a4b0ce089ef91d5345b0aabb653a416adbb206 Mon Sep 17 00:00:00 2001 From: Alberto Bertogli Date: Mon, 24 May 2021 00:27:58 +0100 Subject: [PATCH] docs: Add a page for known issues It's common that people running old releases (for example, because of their Linux distribution version) run into issues that have already been fixed. It can be convenient to have a list of the most common known issues and, when available, their workarounds. This patch creates the documentation page for them, currently empty. It will be filled in subsequent patches. --- .mkdocs.yml | 1 + docs/knownissues.md | 11 +++++++++++ 2 files changed, 12 insertions(+) create mode 100644 docs/knownissues.md diff --git a/.mkdocs.yml b/.mkdocs.yml index 0d297a1..f1e1766 100644 --- a/.mkdocs.yml +++ b/.mkdocs.yml @@ -33,4 +33,5 @@ nav: - sec-levels.md - tests.md - relnotes.md + - knownissues.md diff --git a/docs/knownissues.md b/docs/knownissues.md new file mode 100644 index 0000000..9645ea4 --- /dev/null +++ b/docs/knownissues.md @@ -0,0 +1,11 @@ + +# Known issues + +This file contains a list of the most common known issues, and the release +range affected. It can be useful for people running older versions, to +identify problems (and workarounds) faster. + +Entries are eventually be purged once their affected versions become uncommon, +to prevent confusion. + +