From 48fc93bbdcc4a23a6b12aab044291e1e2f5ab42b Mon Sep 17 00:00:00 2001 From: "Michael Ko. Gajda" Date: Mon, 29 Nov 2021 14:36:47 +0100 Subject: [PATCH 1/4] Add simple overview README for docs --- docs/README.md | 7 +++++++ 1 file changed, 7 insertions(+) create mode 100644 docs/README.md diff --git a/docs/README.md b/docs/README.md new file mode 100644 index 00000000..b86d99fb --- /dev/null +++ b/docs/README.md @@ -0,0 +1,7 @@ +# Official headscale documentation + +* [Configuration](Configuration.md) +* [Running](Running.md) +* [DNS](DNS.md) +* [TLS](TLS.md) +* [Glossary](Glossary.md) From 78eba97bf9849c6acc5973382c2e758b60be1f09 Mon Sep 17 00:00:00 2001 From: "Michael Ko. Gajda" Date: Mon, 29 Nov 2021 14:37:00 +0100 Subject: [PATCH 2/4] Add GitHub templates --- .github/ISSUE_TEMPLATE/bug_report.md | 25 +++++++++++++++++++++++ .github/ISSUE_TEMPLATE/config.yml | 11 ++++++++++ .github/ISSUE_TEMPLATE/feature_request.md | 14 +++++++++++++ .github/ISSUE_TEMPLATE/other_issue.md | 25 +++++++++++++++++++++++ .github/pull_request_template.md | 10 +++++++++ 5 files changed, 85 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/bug_report.md create mode 100644 .github/ISSUE_TEMPLATE/config.yml create mode 100644 .github/ISSUE_TEMPLATE/feature_request.md create mode 100644 .github/ISSUE_TEMPLATE/other_issue.md create mode 100644 .github/pull_request_template.md diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md new file mode 100644 index 00000000..2ca3ecfa --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -0,0 +1,25 @@ +--- +name: 'Bug report' +about: 'Create a bug report to help us improve' +title: '' +labels: [ 'bug' ] +assignees: '' +--- + +**Bug description** + + +**To Reproduce** + + +**Context info** + diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 00000000..d1937779 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,11 @@ +# Issues must have some content +blank_issues_enabled: false + +# Contact links +contact_links: + - name: "headsacle usage documentation" + url: "https://github.com/juanfont/headscale/blob/main/docs" + about: "Find documentation about how to configure and run headscale." + - name: "headscale Discord community" + url: "https://discord.com/invite/XcQxk2VHjx" + about: "Please ask and answer questions about usage of headscale here." diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md new file mode 100644 index 00000000..141ac042 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -0,0 +1,14 @@ +--- +name: 'Feature request' +about: 'Suggest an idea for headscale' +title: '' +labels: [ 'enhancement' ] +assignees: '' +--- + +**Feature request** + + + diff --git a/.github/ISSUE_TEMPLATE/other_issue.md b/.github/ISSUE_TEMPLATE/other_issue.md new file mode 100644 index 00000000..7d9c11c3 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/other_issue.md @@ -0,0 +1,25 @@ +--- +name: 'Other issue' +about: 'Report a different issue' +title: '' +labels: [ 'bug' ] +assignees: '' +--- + + + +**Issue description** + + +**To Reproduce** + + +**Context info** + diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md new file mode 100644 index 00000000..c7015806 --- /dev/null +++ b/.github/pull_request_template.md @@ -0,0 +1,10 @@ + + +- [] read the [CONTRIBUTING guidelines](README.md#user-content-contributing) +- [] raised a GitHub issue or discussed it on the projects chat beforehand +- [] added unit tests +- [] added integration tests +- [] updated documentation if needed +- [] updated CHANGELOG.md + + From 0c13d9da156b03b4400c48a586a907c54d598ff9 Mon Sep 17 00:00:00 2001 From: "Michael Ko. Gajda" Date: Sat, 4 Dec 2021 18:51:09 +0100 Subject: [PATCH 3/4] Fix format with prettier --- .github/ISSUE_TEMPLATE/bug_report.md | 13 ++++++++----- .github/ISSUE_TEMPLATE/feature_request.md | 11 ++++++----- .github/ISSUE_TEMPLATE/other_issue.md | 13 ++++++++----- docs/README.md | 10 +++++----- 4 files changed, 27 insertions(+), 20 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index 2ca3ecfa..f0902132 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -1,20 +1,23 @@ --- -name: 'Bug report' -about: 'Create a bug report to help us improve' -title: '' -labels: [ 'bug' ] -assignees: '' +name: "Bug report" +about: "Create a bug report to help us improve" +title: "" +labels: ["bug"] +assignees: "" --- **Bug description** + **To Reproduce** + **Context info** + **Issue description** + **To Reproduce** + **Context info** +