From f8f74ab57289614949750e5693ad17e457eb95c0 Mon Sep 17 00:00:00 2001 From: Peter van Dijk Date: Wed, 3 Feb 2021 11:18:22 +0100 Subject: [PATCH] docs: add GPL license to all 3 product docs --- docs/common/license.rst | 6 ++++++ docs/common/security-policy.rst | 2 +- docs/indexTOC.rst | 1 + pdns/dnsdistdist/docs/common | 1 + pdns/dnsdistdist/docs/conf.py | 8 +++++++- pdns/dnsdistdist/docs/index_TOC.rst | 3 ++- pdns/dnsdistdist/docs/security-advisories/index.rst | 2 +- .../docs/security-advisories/security-policy.rst | 1 - pdns/recursordist/docs/conf.py | 2 +- pdns/recursordist/docs/indexTOC.rst | 2 +- 10 files changed, 21 insertions(+), 7 deletions(-) create mode 100644 docs/common/license.rst create mode 120000 pdns/dnsdistdist/docs/common delete mode 120000 pdns/dnsdistdist/docs/security-advisories/security-policy.rst diff --git a/docs/common/license.rst b/docs/common/license.rst new file mode 100644 index 0000000000..081ca91ab7 --- /dev/null +++ b/docs/common/license.rst @@ -0,0 +1,6 @@ +PowerDNS/dnsdist license +======================== + +We remind PowerDNS and dnsdist users that under the terms of the GNU General Public License, PowerDNS and dnsdist come with ABSOLUTELY NO WARRANTY. + +.. literalinclude:: ../../COPYING diff --git a/docs/common/security-policy.rst b/docs/common/security-policy.rst index dfb916dd72..3f457a9f44 100644 --- a/docs/common/security-policy.rst +++ b/docs/common/security-policy.rst @@ -8,7 +8,7 @@ Please do not mail security issues to public lists, nor file a ticket, unless we We fully credit reporters of security issues, and respond quickly, but please allow us a reasonable timeframe to coordinate a response. We remind PowerDNS and dnsdist users that under the terms of the GNU General Public License, PowerDNS and dnsdist come with ABSOLUTELY NO WARRANTY. -This license is included in this documentation. +This :doc:`license <../common/license>` is included in this documentation. If you believe you have found a security vulnerability that applies to DNS implementations generally, and you want to report this responsibly to a number of implementers, you might consider also using the `Open Source DNS Vulnerability mailing list `_, managed by `DNS-OARC `_. diff --git a/docs/indexTOC.rst b/docs/indexTOC.rst index a47aa950d6..bad9bfcab9 100644 --- a/docs/indexTOC.rst +++ b/docs/indexTOC.rst @@ -26,3 +26,4 @@ PowerDNS Authoritative Server security-advisories/index changelog/index appendices/* + common/license diff --git a/pdns/dnsdistdist/docs/common b/pdns/dnsdistdist/docs/common new file mode 120000 index 0000000000..b115a64599 --- /dev/null +++ b/pdns/dnsdistdist/docs/common @@ -0,0 +1 @@ +../../../docs/common \ No newline at end of file diff --git a/pdns/dnsdistdist/docs/conf.py b/pdns/dnsdistdist/docs/conf.py index 232af4d268..8c2fa93214 100644 --- a/pdns/dnsdistdist/docs/conf.py +++ b/pdns/dnsdistdist/docs/conf.py @@ -70,7 +70,13 @@ language = None # List of patterns, relative to source directory, that match files and # directories to ignore when looking for source files. # This patterns also effect to html_static_path and html_extra_path -exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store', '.venv'] +exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store', '.venv', + 'http-api/override.rst', + 'common/zonemetadata.rst', + 'common/endpoint-servers-config.rst', + 'common/secpoll.rst', + 'common/api/*.rst', + 'common/tarball-pgp-keys.rst'] # The name of the Pygments (syntax highlighting) style to use. pygments_style = 'sphinx' diff --git a/pdns/dnsdistdist/docs/index_TOC.rst b/pdns/dnsdistdist/docs/index_TOC.rst index efd140bc02..c1f893da55 100644 --- a/pdns/dnsdistdist/docs/index_TOC.rst +++ b/pdns/dnsdistdist/docs/index_TOC.rst @@ -18,5 +18,6 @@ Table of Contents changelog upgrade_guide security-advisories/index - security-advisories/security-policy + common/security-policy glossary + common/license diff --git a/pdns/dnsdistdist/docs/security-advisories/index.rst b/pdns/dnsdistdist/docs/security-advisories/index.rst index 875c75010e..3d73917569 100644 --- a/pdns/dnsdistdist/docs/security-advisories/index.rst +++ b/pdns/dnsdistdist/docs/security-advisories/index.rst @@ -9,4 +9,4 @@ All security advisories for the DNSDist are listed here. powerdns-advisory-for-dnsdist* -If you have a security problem to report, please see our :doc:`security policy `. +If you have a security problem to report, please see our :doc:`security policy <../common/security-policy>`. diff --git a/pdns/dnsdistdist/docs/security-advisories/security-policy.rst b/pdns/dnsdistdist/docs/security-advisories/security-policy.rst deleted file mode 120000 index 2fbb4914e2..0000000000 --- a/pdns/dnsdistdist/docs/security-advisories/security-policy.rst +++ /dev/null @@ -1 +0,0 @@ -../../../../docs/common/security-policy.rst \ No newline at end of file diff --git a/pdns/recursordist/docs/conf.py b/pdns/recursordist/docs/conf.py index 68b28c784a..4a628ff187 100644 --- a/pdns/recursordist/docs/conf.py +++ b/pdns/recursordist/docs/conf.py @@ -73,7 +73,7 @@ language = None # List of patterns, relative to source directory, that match files and # directories to ignore when looking for source files. # This patterns also effect to html_static_path and html_extra_path -exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store', +exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store', '.venv', 'http-api/override.rst', 'common/zonemetadata.rst', 'common/endpoint-servers-config.rst', diff --git a/pdns/recursordist/docs/indexTOC.rst b/pdns/recursordist/docs/indexTOC.rst index 2f884b45a9..2dabb3d88d 100644 --- a/pdns/recursordist/docs/indexTOC.rst +++ b/pdns/recursordist/docs/indexTOC.rst @@ -22,4 +22,4 @@ PowerDNS Recursor upgrade changelog/index appendices/* - + common/license -- 2.47.2