From b3e18df76fa8dfb2e9c0c3280c010d95cf84624f Mon Sep 17 00:00:00 2001 From: Michael Date: Sun, 2 Feb 2025 20:13:03 +0100 Subject: [PATCH 01/13] Update issue templates --- .github/ISSUE_TEMPLATE/clarification-request.md | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/clarification-request.md diff --git a/.github/ISSUE_TEMPLATE/clarification-request.md b/.github/ISSUE_TEMPLATE/clarification-request.md new file mode 100644 index 000000000..239544c10 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/clarification-request.md @@ -0,0 +1,17 @@ +--- +name: Clarification Request +about: Create a report to help us improve the clarity of the Documentation +title: "[Clarification Request]" +labels: '' +assignees: '' + +--- + +**Describe the issue** +A clear and concise description of what needs to be clarified. + +**Proposed Clarification Steps** +What should we change to clarify this section of the Documentation? + +**Additional context** +Add any other context about the problem here. From 957e2b5c070b9599a1e5b6a32dc455ea8f100768 Mon Sep 17 00:00:00 2001 From: Michael Date: Sun, 2 Feb 2025 20:14:07 +0100 Subject: [PATCH 02/13] Create config.yml --- .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 000000000..5ef40c496 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,5 @@ +blank_issues_enabled: false +contact_links: + - name: Pterodactyl Discord Server + url: https://discord.gg/pterodactyl/ + about: For issues setting up and running Pterodactyl please go here From 7e407db3609171b13656a9ab96162f79cf326c6e Mon Sep 17 00:00:00 2001 From: Michael Date: Sun, 2 Feb 2025 20:21:31 +0100 Subject: [PATCH 03/13] Update config.yml --- .github/ISSUE_TEMPLATE/config.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml index 5ef40c496..3e96265a9 100644 --- a/.github/ISSUE_TEMPLATE/config.yml +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -1,5 +1,5 @@ blank_issues_enabled: false contact_links: - name: Pterodactyl Discord Server - url: https://discord.gg/pterodactyl/ + url: https://discord.gg/pterodactyl about: For issues setting up and running Pterodactyl please go here From 0ecd7b564091c464e9a6299c51ed3608c9823ebf Mon Sep 17 00:00:00 2001 From: Michael Date: Sun, 2 Feb 2025 21:36:15 +0100 Subject: [PATCH 04/13] Made clarification-request.md a form --- .../ISSUE_TEMPLATE/clarification-request.md | 38 ++++++++++++++----- 1 file changed, 28 insertions(+), 10 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/clarification-request.md b/.github/ISSUE_TEMPLATE/clarification-request.md index 239544c10..bd6bda3d5 100644 --- a/.github/ISSUE_TEMPLATE/clarification-request.md +++ b/.github/ISSUE_TEMPLATE/clarification-request.md @@ -1,17 +1,35 @@ ---- name: Clarification Request about: Create a report to help us improve the clarity of the Documentation title: "[Clarification Request]" labels: '' assignees: '' ---- +body: + - type: checkboxes + id: already_searched + attributes: + label: "Have you checked if this is already explained elsewhere in the documentation?" + options: + - label: "Yes, but I still need clarification." + required: true + - type: markdown + attributes: + value: "### Please fill in all required fields before submitting." + + - type: input + id: clarif_description + attributes: + label: "Describe the issue" + description: "A clear and concise description of what needs to be clarified." + placeholder: "Write your issue here..." + validations: + required: true # This prevents empty reports -**Describe the issue** -A clear and concise description of what needs to be clarified. - -**Proposed Clarification Steps** -What should we change to clarify this section of the Documentation? - -**Additional context** -Add any other context about the problem here. + - type: textarea + id: clarif_fix + attributes: + label: "Proposed Clarification Steps" + description: "What should we change to clarify this section of the Documentation?" + placeholder: "Add your suggestion on how to clarify this section here..." + validations: + required: true From fa6e45a849668a26169e53dff083d812d264ff68 Mon Sep 17 00:00:00 2001 From: Michael Date: Sun, 2 Feb 2025 21:36:51 +0100 Subject: [PATCH 05/13] Update clarification-request.md --- .github/ISSUE_TEMPLATE/clarification-request.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/.github/ISSUE_TEMPLATE/clarification-request.md b/.github/ISSUE_TEMPLATE/clarification-request.md index bd6bda3d5..e941deeff 100644 --- a/.github/ISSUE_TEMPLATE/clarification-request.md +++ b/.github/ISSUE_TEMPLATE/clarification-request.md @@ -1,8 +1,10 @@ +--- name: Clarification Request about: Create a report to help us improve the clarity of the Documentation title: "[Clarification Request]" labels: '' assignees: '' +--- body: - type: checkboxes From 310d73c79986d483791995a64d33ffcca92b7c18 Mon Sep 17 00:00:00 2001 From: Michael Date: Sun, 2 Feb 2025 21:39:59 +0100 Subject: [PATCH 06/13] Update clarification-request.md --- .github/ISSUE_TEMPLATE/clarification-request.md | 4 +--- 1 file changed, 1 insertion(+), 3 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/clarification-request.md b/.github/ISSUE_TEMPLATE/clarification-request.md index e941deeff..9777b4ce3 100644 --- a/.github/ISSUE_TEMPLATE/clarification-request.md +++ b/.github/ISSUE_TEMPLATE/clarification-request.md @@ -1,10 +1,8 @@ ---- name: Clarification Request -about: Create a report to help us improve the clarity of the Documentation +description: Create a report to help us improve the clarity of the Documentation title: "[Clarification Request]" labels: '' assignees: '' ---- body: - type: checkboxes From 8c535afc5f7dae4b8e86f5ccd5c498d573d241f7 Mon Sep 17 00:00:00 2001 From: Michael Date: Sun, 2 Feb 2025 21:40:49 +0100 Subject: [PATCH 07/13] Rename clarification-request.md to clarification-request.yml --- .../{clarification-request.md => clarification-request.yml} | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename .github/ISSUE_TEMPLATE/{clarification-request.md => clarification-request.yml} (100%) diff --git a/.github/ISSUE_TEMPLATE/clarification-request.md b/.github/ISSUE_TEMPLATE/clarification-request.yml similarity index 100% rename from .github/ISSUE_TEMPLATE/clarification-request.md rename to .github/ISSUE_TEMPLATE/clarification-request.yml From 4686ceedd1af0a0968268d7655fe2c8d3be88982 Mon Sep 17 00:00:00 2001 From: Michael Date: Sun, 2 Feb 2025 21:41:09 +0100 Subject: [PATCH 08/13] Update clarification-request.yml --- .github/ISSUE_TEMPLATE/clarification-request.yml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/clarification-request.yml b/.github/ISSUE_TEMPLATE/clarification-request.yml index 9777b4ce3..c67443c93 100644 --- a/.github/ISSUE_TEMPLATE/clarification-request.yml +++ b/.github/ISSUE_TEMPLATE/clarification-request.yml @@ -1,8 +1,8 @@ name: Clarification Request description: Create a report to help us improve the clarity of the Documentation title: "[Clarification Request]" -labels: '' -assignees: '' +labels: [] +assignees: [] body: - type: checkboxes From f71be1792e7ac9ad4503f1f3cc32ceaf1a2828d7 Mon Sep 17 00:00:00 2001 From: Michael Date: Sun, 2 Feb 2025 21:46:18 +0100 Subject: [PATCH 09/13] Create enhancement.yml --- .github/ISSUE_TEMPLATE/enhancement.yml | 23 +++++++++++++++++++++++ 1 file changed, 23 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/enhancement.yml diff --git a/.github/ISSUE_TEMPLATE/enhancement.yml b/.github/ISSUE_TEMPLATE/enhancement.yml new file mode 100644 index 000000000..c9caa8d90 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/enhancement.yml @@ -0,0 +1,23 @@ +name: Enhancement +description: Tell us how to improve the documentation +title: "[Enhancement]: " +labels: [] +assignees: [] +body: + - type: markdown + attributes: + value: "### Please fill in all required fields before submitting." + - type: checkboxes + id: already_searched + attributes: + label: "Have you checked if this is already explained elsewhere in the documentation?" + options: + - label: "Yes" + required: true + - type: textarea + id: what-to-add + attributes: + description: What do you want to see added to the Documentation? + placeholder: Tell us what needs to be added! + validations: + required: true From 71affc78d50bc3aa0ddef03ed4d991cf5444f5b7 Mon Sep 17 00:00:00 2001 From: Michael Date: Sun, 2 Feb 2025 21:48:18 +0100 Subject: [PATCH 10/13] Update enhancement.yml --- .github/ISSUE_TEMPLATE/enhancement.yml | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/enhancement.yml b/.github/ISSUE_TEMPLATE/enhancement.yml index c9caa8d90..09be6b9d2 100644 --- a/.github/ISSUE_TEMPLATE/enhancement.yml +++ b/.github/ISSUE_TEMPLATE/enhancement.yml @@ -4,16 +4,16 @@ title: "[Enhancement]: " labels: [] assignees: [] body: - - type: markdown - attributes: - value: "### Please fill in all required fields before submitting." - type: checkboxes id: already_searched attributes: label: "Have you checked if this is already explained elsewhere in the documentation?" options: - - label: "Yes" + - label: "Yes, but I still need clarification." required: true + - type: markdown + attributes: + value: "### Please fill in all required fields before submitting." - type: textarea id: what-to-add attributes: From 7a1faeef74c80081f733c9faa4632ea28d36298f Mon Sep 17 00:00:00 2001 From: Michael Date: Sun, 2 Feb 2025 21:49:26 +0100 Subject: [PATCH 11/13] Update enhancement.yml --- .github/ISSUE_TEMPLATE/enhancement.yml | 1 + 1 file changed, 1 insertion(+) diff --git a/.github/ISSUE_TEMPLATE/enhancement.yml b/.github/ISSUE_TEMPLATE/enhancement.yml index 09be6b9d2..42891f5a0 100644 --- a/.github/ISSUE_TEMPLATE/enhancement.yml +++ b/.github/ISSUE_TEMPLATE/enhancement.yml @@ -17,6 +17,7 @@ body: - type: textarea id: what-to-add attributes: + label: "Proposed Enhancement" description: What do you want to see added to the Documentation? placeholder: Tell us what needs to be added! validations: From 1da73fbee9ba64dd3e9bd405614fa48b8838575d Mon Sep 17 00:00:00 2001 From: Michael Date: Sun, 2 Feb 2025 21:49:38 +0100 Subject: [PATCH 12/13] Update clarification-request.yml --- .github/ISSUE_TEMPLATE/clarification-request.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/ISSUE_TEMPLATE/clarification-request.yml b/.github/ISSUE_TEMPLATE/clarification-request.yml index c67443c93..36b644d2a 100644 --- a/.github/ISSUE_TEMPLATE/clarification-request.yml +++ b/.github/ISSUE_TEMPLATE/clarification-request.yml @@ -1,6 +1,6 @@ name: Clarification Request description: Create a report to help us improve the clarity of the Documentation -title: "[Clarification Request]" +title: "[Clarification Request]: " labels: [] assignees: [] From 0ef12d7e962681b666a760f147b864785d1bddc0 Mon Sep 17 00:00:00 2001 From: Michael Date: Sun, 2 Feb 2025 22:02:04 +0100 Subject: [PATCH 13/13] Update enhancement.yml --- .github/ISSUE_TEMPLATE/enhancement.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/ISSUE_TEMPLATE/enhancement.yml b/.github/ISSUE_TEMPLATE/enhancement.yml index 42891f5a0..1d9dfe171 100644 --- a/.github/ISSUE_TEMPLATE/enhancement.yml +++ b/.github/ISSUE_TEMPLATE/enhancement.yml @@ -9,7 +9,7 @@ body: attributes: label: "Have you checked if this is already explained elsewhere in the documentation?" options: - - label: "Yes, but I still need clarification." + - label: "Yes" required: true - type: markdown attributes: