From e1596fbdd5794fa8d6f3b4de5fabd6321b71b377 Mon Sep 17 00:00:00 2001 From: Franck Nijhof Date: Tue, 9 Feb 2021 15:43:24 +0100 Subject: [PATCH] Documentation feedback issue form (#16472) Co-authored-by: Martin Hjelmare --- .github/ISSUE_TEMPLATE.md | 26 ++++++++++++-- .github/ISSUE_TEMPLATE/DOCS_ISSUE.md | 11 ------ .github/ISSUE_TEMPLATE/feedback.yml | 51 ++++++++++++++++++++++++++++ 3 files changed, 74 insertions(+), 14 deletions(-) delete mode 100644 .github/ISSUE_TEMPLATE/DOCS_ISSUE.md create mode 100644 .github/ISSUE_TEMPLATE/feedback.yml diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md index 73ec498014a..73f53af73d0 100644 --- a/.github/ISSUE_TEMPLATE.md +++ b/.github/ISSUE_TEMPLATE.md @@ -1,7 +1,27 @@ -## The problem +## Feedback + +## Details + + +URL: + + +Version: diff --git a/.github/ISSUE_TEMPLATE/DOCS_ISSUE.md b/.github/ISSUE_TEMPLATE/DOCS_ISSUE.md deleted file mode 100644 index 878ec4b21cb..00000000000 --- a/.github/ISSUE_TEMPLATE/DOCS_ISSUE.md +++ /dev/null @@ -1,11 +0,0 @@ ---- -name: Website/Docs bug report -about: Report incorrect/missing information or other issues with our website. ---- -## The problem - - - diff --git a/.github/ISSUE_TEMPLATE/feedback.yml b/.github/ISSUE_TEMPLATE/feedback.yml new file mode 100644 index 00000000000..33a0edfc113 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feedback.yml @@ -0,0 +1,51 @@ +name: Documentation feedback +about: Provide feedback on a page on our website +title: "" +issue_body: true +inputs: + - type: description + attributes: | + Thanks for opening an issue to provide feedback on our website/documentation. + + Please note, this form is not for reporting bugs with running Home Assistant or its integrations. + Those bugs should be reported in the [Home Assistant Core issue tracker][core]. + + [core]: https://github.com/home-assistant/core/issues + - type: textarea + attributes: + label: Feedback + required: true + description: >- + Please be sure to provide feedback as clear as possible. Describe what + you think is incorrect or can be improved, and try to provide a + suggestion on how you think it can be improved or fixed. + - type: description + attributes: + value: | + ## Details + - type: input + attributes: + label: URL + required: true + placeholder: "http://www.home-assistant.io/..." + description: >- + A URL with a link to the page you are providing feedback for. + - type: input + attributes: + label: Version + required: false + placeholder: "e.g., 2021.2.0" + description: >- + Current version of the documentation. This usually matches the Home + Assistant Core release version, and can be found at the bottom of the + page. + - type: description + attributes: + value: | + ## Additional information + - type: description + attributes: + value: > + If you have any additional information for us, use the field below. + Please note, you can attach screenshots or screen recordings here, by + dragging and dropping files in the field below.