From e912cf7fb62941d87420dc47ccf96a312c70bba6 Mon Sep 17 00:00:00 2001 From: simon Date: Thu, 10 Nov 2022 09:53:49 +0700 Subject: [PATCH] rename to *common errors*, better issue template --- .github/ISSUE_TEMPLATE/BUG-REPORT.yml | 4 +++- .github/ISSUE_TEMPLATE/INSTALLATION-HELP.yml | 2 +- README.md | 4 ++-- 3 files changed, 6 insertions(+), 4 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/BUG-REPORT.yml b/.github/ISSUE_TEMPLATE/BUG-REPORT.yml index dd0b723..b9f051a 100644 --- a/.github/ISSUE_TEMPLATE/BUG-REPORT.yml +++ b/.github/ISSUE_TEMPLATE/BUG-REPORT.yml @@ -11,10 +11,12 @@ body: - type: checkboxes id: latest attributes: - label: Latest and Greatest + label: I've read the documentation: options: - label: I'm running the latest version of Tube Archivist and have read the [release notes](https://github.com/tubearchivist/tubearchivist/releases/latest). required: true + - label: I have read through the [wiki](https://github.com/tubearchivist/tubearchivist/wiki) and the [readme](https://github.com/tubearchivist/tubearchivist#installing-and-updating), particularly the [common errors](https://github.com/tubearchivist/tubearchivist#common-errors) section. + required: true - type: input id: os diff --git a/.github/ISSUE_TEMPLATE/INSTALLATION-HELP.yml b/.github/ISSUE_TEMPLATE/INSTALLATION-HELP.yml index 8459327..07519dc 100644 --- a/.github/ISSUE_TEMPLATE/INSTALLATION-HELP.yml +++ b/.github/ISSUE_TEMPLATE/INSTALLATION-HELP.yml @@ -15,7 +15,7 @@ body: options: - label: I have read and understand the [installation instructions](https://github.com/tubearchivist/tubearchivist#installing-and-updating). required: true - - label: My issue is not described in the [potential pitfalls](https://github.com/tubearchivist/tubearchivist#potential-pitfalls) section. + - label: My issue is not described in the [common errors](https://github.com/tubearchivist/tubearchivist#common-errors) section. required: true - type: input diff --git a/README.md b/README.md index 4a406d7..bf029fd 100644 --- a/README.md +++ b/README.md @@ -16,7 +16,7 @@ * [Extended Universe](#extended-universe) * [Installing and updating](#installing-and-updating) * [Getting Started](#getting-started) -* [Potential pitfalls](#potential-pitfalls) +* [Common Errors](#common-errors) * [Roadmap](#roadmap) * [Known limitations](#known-limitations) * [Donate](#donate) @@ -165,7 +165,7 @@ You will see the current version number of **Tube Archivist** in the footer of t There is a Helm Chart available at https://github.com/insuusvenerati/helm-charts. Mostly self-explanatory but feel free to ask questions in the discord / subreddit. -## Potential pitfalls +## Common Errors ### vm.max_map_count **Elastic Search** in Docker requires the kernel setting of the host machine `vm.max_map_count` to be set to at least 262144.