From cf2d33daadc3b93609a57c5898137791ae1d9f0b Mon Sep 17 00:00:00 2001 From: Maximilian Jannack Date: Thu, 13 Jan 2022 21:17:08 +0100 Subject: [PATCH 1/2] Disabled old issue templates and added new ones with new GitHub issues format --- .../{bug_report.md => bug_report.md.bak} | 0 .github/ISSUE_TEMPLATE/bug_report.yml | 63 ++++++++++++++ ...ture_request.md => feature_request.md.bak} | 0 .github/ISSUE_TEMPLATE/feature_request.yml | 39 +++++++++ .../{help-request.md => help-request.md.bak} | 0 .github/ISSUE_TEMPLATE/help_request.yml | 82 +++++++++++++++++++ .../{url_import.md => url_import.md.bak} | 0 .github/ISSUE_TEMPLATE/website_import.yml | 36 ++++++++ 8 files changed, 220 insertions(+) rename .github/ISSUE_TEMPLATE/{bug_report.md => bug_report.md.bak} (100%) create mode 100644 .github/ISSUE_TEMPLATE/bug_report.yml rename .github/ISSUE_TEMPLATE/{feature_request.md => feature_request.md.bak} (100%) create mode 100644 .github/ISSUE_TEMPLATE/feature_request.yml rename .github/ISSUE_TEMPLATE/{help-request.md => help-request.md.bak} (100%) create mode 100644 .github/ISSUE_TEMPLATE/help_request.yml rename .github/ISSUE_TEMPLATE/{url_import.md => url_import.md.bak} (100%) create mode 100644 .github/ISSUE_TEMPLATE/website_import.yml diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md.bak similarity index 100% rename from .github/ISSUE_TEMPLATE/bug_report.md rename to .github/ISSUE_TEMPLATE/bug_report.md.bak diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml new file mode 100644 index 0000000000..2fdbcc3ba1 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -0,0 +1,63 @@ +name: Bug Report +description: "Create a report to help us improve" +#title: "" +#labels: ["Bug"] +body: + - type: markdown + attributes: + value: | + Thanks for taking the time to fill out this bug report! + - type: input + id: version + attributes: + label: Tandoor Version + description: "What version of Tandoor are you using? (can be found on the system page since v0.8.4)" + validations: + required: true + - type: dropdown + id: setup + attributes: + label: Setup + description: "How is your Tandoor instance set up?" + options: + - Docker / Docker-Compose + - Unraid + - Synology + - Kubernetes + - Manual Setup + - Others (please state below) + validations: + required: true + - type: dropdown + id: reverse-proxy + attributes: + label: "Reverse Proxy" + description: "What reverse proxy do you use with Tandoor?" + options: + - No reverse proxy + - jwilder's nginx proxy + - Nginx Proxy Manager (NPM) + - SWAG + - Caddy + - Traefik + - Others (please state below) + validations: + required: true + - type: input + id: other + attributes: + label: Other + description: "In case you chose 'Others' above, please provide more info here." + - type: textarea + id: bug-descr + attributes: + label: Bug description + description: "Please accurately describe the bug you encountered." + validations: + required: true + - type: textarea + id: logs + attributes: + label: Relevant logs + description: Please copy and paste any relevant logs. This will be automatically formatted into code, so no need for backticks. + render: shell diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md.bak similarity index 100% rename from .github/ISSUE_TEMPLATE/feature_request.md rename to .github/ISSUE_TEMPLATE/feature_request.md.bak diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml new file mode 100644 index 0000000000..ad823cfacc --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.yml @@ -0,0 +1,39 @@ +name: Feature Request +description: "Suggest an idea for this project" +#title: "" +labels: ["enhancement"] +body: + - type: markdown + attributes: + value: | + Thanks for taking the time to fill out this feature request! + - type: textarea + id: problem + attributes: + label: "Is your feature request related to a problem? Please describe." + description: "A clear and concise description of what the problem is. Ex. I'm always frustrated when..." + - type: textarea + id: solution + attributes: + label: "Describe the solution you'd like" + description: "A clear and concise description of what you want to happen." + validations: + required: true + - type: textarea + id: alternatives + attributes: + label: "Describe alternatives you've considered" + description: "A clear and concise description of any alternative solutions or features you've considered." + - type: textarea + id: additional + attributes: + label: "Additional context" + description: "Add any other context or screenshots about the feature request here." + - type: checkboxes + attributes: + label: "Contribute" + description: "Are you willing and able to help develop this feature?" + options: + - label: "Yes" + - label: "Partly" + - label: "No" diff --git a/.github/ISSUE_TEMPLATE/help-request.md b/.github/ISSUE_TEMPLATE/help-request.md.bak similarity index 100% rename from .github/ISSUE_TEMPLATE/help-request.md rename to .github/ISSUE_TEMPLATE/help-request.md.bak diff --git a/.github/ISSUE_TEMPLATE/help_request.yml b/.github/ISSUE_TEMPLATE/help_request.yml new file mode 100644 index 0000000000..55c904ee53 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/help_request.yml @@ -0,0 +1,82 @@ +name: Help request +description: "If there is anything wrong with your setup" +#title: "" +labels: ["setup issue"] +body: + - type: markdown + attributes: + value: | + Thanks for taking the time to fill out this help request! + - type: textarea + id: issue + attributes: + label: Issue + description: "Please describe your problem here." + validations: + required: true + - type: input + id: version + attributes: + label: Tandoor Version + description: "What version of Tandoor are you using? (can be found on the system page since v0.8.4)" + validations: + required: true + - type: input + id: os + attributes: + label: OS Version + description: "E.g. Ubuntu 20.02" + validations: + required: true + - type: dropdown + id: setup + attributes: + label: Setup + description: "How is your Tandoor instance set up?" + options: + - Docker / Docker-Compose + - Unraid + - Synology + - Kubernetes + - Manual Setup + - Others (please state below) + validations: + required: true + - type: dropdown + id: reverse-proxy + attributes: + label: "Reverse Proxy" + description: "What reverse proxy do you use with Tandoor?" + options: + - No reverse proxy + - jwilder's nginx proxy + - Nginx Proxy Manager (NPM) + - SWAG + - Caddy + - Traefik + - Others (please state below) + validations: + required: true + - type: input + id: other + attributes: + label: Other + description: "In case you chose 'Others' above or have more info, please provide additional details here." + - type: textarea + id: env + attributes: + label: Environment file + description: "Please include your `.env` config file (**make sure to remove/replace all secrets**)" + render: shell + - type: textarea + id: docker-compose + attributes: + label: Docker-Compose file + description: "When running with docker compose please provide your `docker-compose.yml`" + render: shell + - type: textarea + id: logs + attributes: + label: Relevant logs + description: "If you feel like there is anything interesting please post the output of `docker-compose logs` at container startup and when the issue happens." + render: shell diff --git a/.github/ISSUE_TEMPLATE/url_import.md b/.github/ISSUE_TEMPLATE/url_import.md.bak similarity index 100% rename from .github/ISSUE_TEMPLATE/url_import.md rename to .github/ISSUE_TEMPLATE/url_import.md.bak diff --git a/.github/ISSUE_TEMPLATE/website_import.yml b/.github/ISSUE_TEMPLATE/website_import.yml new file mode 100644 index 0000000000..aeba4fbd22 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/website_import.yml @@ -0,0 +1,36 @@ +name: Website Import +description: "Anything related to website imports" +#title: "" +#labels: ["enhancement"] +body: + - type: markdown + attributes: + value: | + Thanks for taking the time to fill out this website import form! + - type: input + id: version + attributes: + label: Tandoor Version + description: "What version of Tandoor are you using? (can be found on the system page since v0.8.4)" + validations: + required: true + - type: input + id: url + attributes: + label: Import URL + description: "Exact URL you are trying to import from." + validations: + required: true + - type: textarea + id: bug-descr + attributes: + label: "When did the issue happen?" + description: "When pressing the search button with the url / when importing after the page has loaded / ..." + validations: + required: true + - type: textarea + id: logs + attributes: + label: Response / message shown + description: Please copy and paste any relevant logs or responses / messages which are shown in Tandoor. This will be automatically formatted into code, so no need for backticks. + render: shell From ffa91863dd131e25822b212821ed136162700812 Mon Sep 17 00:00:00 2001 From: Maximilian Jannack Date: Thu, 13 Jan 2022 21:26:15 +0100 Subject: [PATCH 2/2] Added config.yml for FAQ link --- .github/ISSUE_TEMPLATE/config.yml | 5 +++++ 1 file changed, 5 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/config.yml diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 0000000000..f867d5c8de --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,5 @@ +blank_issues_enabled: true +contact_links: + - name: FAQs + url: https://docs.tandoor.dev/faq/ + about: Please take a look at the FAQs before creating a bug ticket.