From 13b185e66fd10085bc7d26b9d51e73bdcd79537a Mon Sep 17 00:00:00 2001 From: Matthias Mair Date: Tue, 10 Jun 2025 12:30:32 +0200 Subject: [PATCH] chore: make issue template clearer (#9753) * make template more clear regarding reproduction * use dropdown for deployment method * add stable ref * fix syntax --- .github/ISSUE_TEMPLATE/bug_report.yaml | 34 +++++++++++++++++--------- docs/mkdocs.yml | 1 + 2 files changed, 24 insertions(+), 11 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.yaml b/.github/ISSUE_TEMPLATE/bug_report.yaml index de16c772a6..3adc70fa4b 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.yaml +++ b/.github/ISSUE_TEMPLATE/bug_report.yaml @@ -6,7 +6,7 @@ body: id: no-duplicate-issues attributes: label: "Please verify that this bug has NOT been raised before." - description: "Search in the issues sections by clicking [HERE](https://github.com/inventree/inventree/issues?q=) and read the [Frequently Asked Questions](https://docs.inventree.org/en/latest/faq/)!" + description: "Search in the issues sections by clicking [HERE](https://github.com/inventree/inventree/issues?q=) and read the [Frequently Asked Questions](https://docs.inventree.org/en/latest/sref/faq)!" options: - label: "I checked and didn't find a similar issue" required: true @@ -37,15 +37,15 @@ body: label: "Expected behaviour" description: "A clear and concise description of what you expected to happen." placeholder: "..." - - type: checkboxes + - type: dropdown id: deployment attributes: label: "Deployment Method" options: - - label: "Docker" - - label: "Package" - - label: "Bare metal" - - label: "Other - added info in Steps to Reproduce" + - Docker + - Package + - Bare metal + - Other - added info in Steps to Reproduce - type: textarea id: version-info validations: @@ -54,13 +54,25 @@ body: label: "Version Information" description: "The version info block." placeholder: "You can get this by going to the `About InvenTree` section in the upper right corner and clicking on the `copy version information` button" - - type: checkboxes - id: can-reproduce + - type: dropdown + id: tried-reproduce attributes: - label: "Please verify if you can reproduce this bug on the demo site." - description: "You can sign in at [InvenTree Demo](https://demo.inventree.org) with admin:inventree. Note that this instance runs on the latest dev version, so your bug may be fixed there." + label: Try to reproduce on the demo site + description: You can sign in at [InvenTree Demo](https://demo.inventree.org) with admin:inventree. Note that this instance runs on the latest dev version, so your bug may be fixed there. options: - - label: "I can reproduce this bug on the demo site." + - I did not try to reproduce + - I tried to reproduce + validations: + required: true + - type: dropdown + id: result-reproduce + attributes: + label: Is the bug reproducible on the demo site? + options: + - Not reproducible + - Reproducible + validations: + required: true - type: textarea id: logs attributes: diff --git a/docs/mkdocs.yml b/docs/mkdocs.yml index 723414faff..96a19c3261 100644 --- a/docs/mkdocs.yml +++ b/docs/mkdocs.yml @@ -281,6 +281,7 @@ plugins: show_root_toc_entry: false - redirects: redirect_maps: + 'sref/faq.md': 'faq.md' # https://docs.inventree.org/en/latest/faq/ 'sref/contrib.md': 'develop/contributing.md' # https://github.com/inventree/InvenTree/blob/master/CONTRIBUTING.md. 'sref/docs.md': 'index.md' # https://docs.inventree.org/en/latest/ 'sref/api.md': 'api/index.md' # https://demo.inventree.org/api-doc/