From 9cdaa360c9d8ccd0680c9901b17253e0aa108e15 Mon Sep 17 00:00:00 2001 From: Florian Preinstorfer Date: Sat, 14 Sep 2024 19:25:19 +0200 Subject: [PATCH] Reuse CONTRIBUTING.md" in the documentation * Include "CONTRIBUTING.md" from the repository root * Update FAQ and index page and link to the contributing docs --- docs/about/contributing.md | 3 +++ docs/about/faq.md | 4 +--- docs/index.md | 2 +- docs/requirements.txt | 1 + mkdocs.yml | 1 + 5 files changed, 7 insertions(+), 4 deletions(-) create mode 100644 docs/about/contributing.md diff --git a/docs/about/contributing.md b/docs/about/contributing.md new file mode 100644 index 00000000..4eeeef13 --- /dev/null +++ b/docs/about/contributing.md @@ -0,0 +1,3 @@ +{% + include-markdown "../../CONTRIBUTING.md" +%} diff --git a/docs/about/faq.md b/docs/about/faq.md index 610235b7..3171d713 100644 --- a/docs/about/faq.md +++ b/docs/about/faq.md @@ -14,9 +14,7 @@ open-source organisation. Headscale is "Open Source, acknowledged contribution", this means that any contribution will have to be discussed with the Maintainers before being submitted. -Headscale is open to code contributions for bug fixes without discussion. - -If you find mistakes in the documentation, please also submit a fix to the documentation. +Please see [Contributing](contributing.md) for more information. ## Why is 'acknowledged contribution' the chosen model? diff --git a/docs/index.md b/docs/index.md index 29cf43d6..981b6a02 100644 --- a/docs/index.md +++ b/docs/index.md @@ -31,7 +31,7 @@ buttons available in the repo. Headscale is "Open Source, acknowledged contribution", this means that any contribution will have to be discussed with the Maintainers before being submitted. -Please see [CONTRIBUTING.md](https://github.com/juanfont/headscale/blob/main/CONTRIBUTING.md) for more information. +Please see [Contributing](about/contributing.md) for more information. ## About diff --git a/docs/requirements.txt b/docs/requirements.txt index 61830d3d..da40fbca 100644 --- a/docs/requirements.txt +++ b/docs/requirements.txt @@ -1,4 +1,5 @@ cairosvg~=2.7.1 +mkdocs-include-markdown-plugin~=6.2.2 mkdocs-material~=9.5.18 mkdocs-minify-plugin~=0.7.1 mkdocs-redirects~=1.2.1 diff --git a/mkdocs.yml b/mkdocs.yml index 4e003c4b..17c6d22f 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -66,6 +66,7 @@ exclude_docs: | plugins: - search: separator: '[\s\-,:!=\[\]()"`/]+|\.(?!\d)|&[lg]t;|(?!\b)(?=[A-Z][a-z])' + - include-markdown: - minify: minify_html: true - social: {}