Merge pull request #13773 from nextcloud/jtr/feat-issue-template-upgrade

feat(meta): Switch to YAML docs form-based issue template
2026-01-02 17:59:36 +07:00 · 2025-10-10 09:04:58 -04:00
parent d597ee7289 de3f00bb6b
commit e8b0ce5d3d
2 changed files with 77 additions and 32 deletions
--- a/.github/ISSUE_TEMPLATE/doc-issue.yml
+++ b/.github/ISSUE_TEMPLATE/doc-issue.yml
@@ -0,0 +1,77 @@
+name: Documentation improvement
+description: Suggest an improvement or report a mistake in the documentation.
+labels:
+  - 0. Needs triage
+body:
+  - type: markdown
+    attributes:
+      value: |
+        #### Thank you for helping improve our documentation!
+        All contributions - whether large or small - help make Nextcloud better and easier to use.
+        
+        There is always room for improvement!
+        ---
+        💡 **Tip:** Make sure you're looking at the latest version of the docs linked from [https://docs.nextcloud.com/](https://docs.nextcloud.com/).
+  - type: checkboxes
+    id: prechecks
+    attributes:
+      label: Before You Submit
+      options:
+        - label: I have checked for existing issues and pull requests related to my suggestion.
+        - label: I have posted on the [Nextcloud Community Help Forum](https://help.nextcloud.com) if my suggestion is a troubleshooting scenario or I'm unsure about the solution.
+  - type: dropdown
+    id: type
+    attributes:
+      label: Type of Suggestion
+      description: Please select the type that best fits your suggestion.
+      options:
+        - Reporting a mistake
+        - Suggesting an improvement
+        - Proposing new documentation content
+        - Other
+      multiple: true
+  - type: input
+    id: links
+    attributes:
+      label: Relevant Documentation Links
+      description: Add URLs of relevant documentation pages here.
+      placeholder: https://docs.nextcloud.com/server/latest/admin_manual/configuration_server/
+  - type: input
+    id: summary
+    attributes:
+      label: Summary
+      description: In one sentence, summarize your suggestion or report.
+      placeholder: Write your summary here.
+  - type: textarea
+    id: details
+    attributes:
+      label: Details
+      description: |
+        Describe your suggestion or idea in detail. If reporting a mistake, include steps to reproduce or context.
+        Example: My amazing idea is [...]
+      placeholder: Describe your idea or report in detail.
+  - type: textarea
+    id: notes
+    attributes:
+      label: Additional Notes
+      description: Any extra information, context, or follow-up links (like forum discussions).
+      placeholder: Add any additional notes here.
+  - type: markdown
+    attributes:
+      value: |
+        ---
+        #### Project Guidance
+
+        - Please be patient: this is a large open source project overseen by a mix of volunteers and non-volunteers, and everyone is ultimately busy.
+        - If your suggestion is a troubleshooting scenario or something you're not 100% certain about, please post for feedback on the [Nextcloud Community Help Forum](https://help.nextcloud.com) first.
+          - Afterwards, return here to share your experience and help improve the documentation for clarity, etc. (and link back to the forum discussion in your report!)
+
+        #### Pro Tip: Want to help even more?
+
+        - Look for areas where you can assist - even seemingly unrelated areas - as doing so frees up resources for your favorite topics and ideas.
+        - Submit a proposed change that addresses your issue as a pull request.
+        - Participate in discussions on other unresolved [submitted ideas ("issues")](https://github.com/nextcloud/documentation/issues) to help move them forward.
+        - Post a comment or review on someone else's [proposed change ("pull request")](https://github.com/nextcloud/documentation/pulls) to help move it along.
+
+        ---
+        Thank you for taking the time to help us make Nextcloud documentation better!
--- a/.github/ISSUE_TEMPLATE/improvement_suggestion.md
+++ b/.github/ISSUE_TEMPLATE/improvement_suggestion.md
@@ -1,32 +0,0 @@
---
-name: Documentation improvement
-about: Suggest an improvement or report a mistake
-labels: 0. Needs triage
---
-
-### Thanks for helping improve our documentation! 
-
-* There is always room for improvement!
-* All contributions (changes and change ideas) - from the largest **to the tiniest** - help make Nextcloud better and easier to use!
-
---
-
-<!-- Please insert your suggestion or idea below this line -->
-
-Example: My amazing idea is [...] <!-- Feel free to delete this line -->
-
-<!-- Please insert your suggestion or idea above this line -->
-
---
-
-#### Notes
-
-* Please be patient: this is a large open source project that is overseen by a mixture of volunteers and non-volunteers which are all ultimately busy.
-* If your suggestion is a troubleshooting scenario or one you're not 100% certain about, please post for feedback on the [Nextcloud Help Forum](https://help.nextcloud.com) first.
-  - *Then* return here to bring back your experience to help improve the documentation for clarity, etc. (and link back to the forum discussion in your report!)
-
-#### Protip: If you want to help move things along (or just help out in other ways too) here are some suggestions:
-* Look for areas where you can assist - even seemingly unrelated areas - *because doing so frees up resources for your favorite topics and ideas*.
-* Submit a proposed change - that attempts to addresses your issue - as a pull request.
-* Participate in a discussion on some other unresolved [submitted idea ("issues")](https://github.com/nextcloud/documentation/issues) to help move it along.
-* Post a comment or review on someone else's [proposed change ("pull request")](https://github.com/nextcloud/documentation/pulls) to help move it along.