From 03099a3e1dd73ddb32cbce59c800b0c6ad099ca2 Mon Sep 17 00:00:00 2001 From: Ian Hoang Date: Thu, 3 Oct 2024 16:37:40 -0500 Subject: [PATCH 1/3] Add new documentation issue template Signed-off-by: Ian Hoang --- .../ISSUE_TEMPLATE/documentation_template.yml | 26 +++++++++++++++++++ 1 file changed, 26 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/documentation_template.yml diff --git a/.github/ISSUE_TEMPLATE/documentation_template.yml b/.github/ISSUE_TEMPLATE/documentation_template.yml new file mode 100644 index 000000000..d92bf779f --- /dev/null +++ b/.github/ISSUE_TEMPLATE/documentation_template.yml @@ -0,0 +1,26 @@ +--- +name: Documentation request 🎆 +description: Suggest new documentation or improvements to existing documentation +labels: [documentation, untriaged] +body: + - type: markdown + attributes: + value: | + Thanks for taking the time to submit a documentation request! + - type: textarea + id: suggestion + attributes: + label: Is there a problem with the current documentation + description: A clear and concise description of what the problem is. Ex. I'm unable to find documentation on [...] + validations: + required: true + - type: textarea + id: references + attributes: + label: Provide references + description: List out links to existing documentation if applicable + - type: textarea + id: additional-context + attributes: + label: Additional context + description: Add any other context or screenshots about the documentation request here. From 79148e30a6916408f2d2b7c04a1750b22af9442a Mon Sep 17 00:00:00 2001 From: Ian Hoang Date: Thu, 3 Oct 2024 16:38:26 -0500 Subject: [PATCH 2/3] Add emoji Signed-off-by: Ian Hoang --- .github/ISSUE_TEMPLATE/documentation_template.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/ISSUE_TEMPLATE/documentation_template.yml b/.github/ISSUE_TEMPLATE/documentation_template.yml index d92bf779f..278f5de10 100644 --- a/.github/ISSUE_TEMPLATE/documentation_template.yml +++ b/.github/ISSUE_TEMPLATE/documentation_template.yml @@ -1,5 +1,5 @@ --- -name: Documentation request 🎆 +name: Documentation request 📖 description: Suggest new documentation or improvements to existing documentation labels: [documentation, untriaged] body: From daf794513985540cd695639b541e1ebb3a3e2ac4 Mon Sep 17 00:00:00 2001 From: Ian Hoang Date: Thu, 24 Oct 2024 10:19:29 -0500 Subject: [PATCH 3/3] Address Govind's comments Signed-off-by: Ian Hoang --- .github/ISSUE_TEMPLATE/documentation_template.yml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/documentation_template.yml b/.github/ISSUE_TEMPLATE/documentation_template.yml index 278f5de10..8522f6260 100644 --- a/.github/ISSUE_TEMPLATE/documentation_template.yml +++ b/.github/ISSUE_TEMPLATE/documentation_template.yml @@ -10,8 +10,8 @@ body: - type: textarea id: suggestion attributes: - label: Is there a problem with the current documentation - description: A clear and concise description of what the problem is. Ex. I'm unable to find documentation on [...] + label: Please provide details on how and where the documentation can be improved + description: A clear and concise description of the issue. For instance, "I'm unable to find documentation on [...]" validations: required: true - type: textarea