1
0
mirror of https://github.com/juanfont/headscale.git synced 2025-10-10 11:14:24 +02:00

Reuse CONTRIBUTING.md" in the documentation

* Include "CONTRIBUTING.md" from the repository root
* Update FAQ and index page and link to the contributing docs
This commit is contained in:
Florian Preinstorfer 2024-09-14 19:25:19 +02:00
parent 5c112241d8
commit 9cdaa360c9
5 changed files with 7 additions and 4 deletions

View File

@ -0,0 +1,3 @@
{%
include-markdown "../../CONTRIBUTING.md"
%}

View File

@ -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?

View File

@ -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

View File

@ -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

View File

@ -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: {}