|
| 1 | +name: Documentation improvement |
| 2 | +description: Suggest an improvement or report a mistake in the documentation. |
| 3 | +labels: |
| 4 | + - 0. Needs triage |
| 5 | +body: |
| 6 | + - type: markdown |
| 7 | + attributes: |
| 8 | + value: | |
| 9 | + #### Thank you for helping improve our documentation! |
| 10 | + All contributions - whether large or small - help make Nextcloud better and easier to use. |
| 11 | + |
| 12 | + There is always room for improvement! |
| 13 | + --- |
| 14 | + 💡 **Tip:** Make sure you're looking at the latest version of the docs linked from [https://docs.nextcloud.com/](https://docs.nextcloud.com/). |
| 15 | + - type: checkboxes |
| 16 | + id: prechecks |
| 17 | + attributes: |
| 18 | + label: Before You Submit |
| 19 | + options: |
| 20 | + - label: I have checked for existing issues and pull requests related to my suggestion. |
| 21 | + - 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. |
| 22 | + - type: dropdown |
| 23 | + id: type |
| 24 | + attributes: |
| 25 | + label: Type of Suggestion |
| 26 | + description: Please select the type that best fits your suggestion. |
| 27 | + options: |
| 28 | + - Reporting a mistake |
| 29 | + - Suggesting an improvement |
| 30 | + - Proposing new documentation content |
| 31 | + - Other |
| 32 | + multiple: true |
| 33 | + - type: input |
| 34 | + id: links |
| 35 | + attributes: |
| 36 | + label: Relevant Documentation Links |
| 37 | + description: Add URLs of relevant documentation pages here. |
| 38 | + placeholder: https://docs.nextcloud.com/server/latest/admin_manual/configuration_server/ |
| 39 | + - type: input |
| 40 | + id: summary |
| 41 | + attributes: |
| 42 | + label: Summary |
| 43 | + description: In one sentence, summarize your suggestion or report. |
| 44 | + placeholder: Write your summary here. |
| 45 | + - type: textarea |
| 46 | + id: details |
| 47 | + attributes: |
| 48 | + label: Details |
| 49 | + description: | |
| 50 | + Describe your suggestion or idea in detail. If reporting a mistake, include steps to reproduce or context. |
| 51 | + Example: My amazing idea is [...] |
| 52 | + placeholder: Describe your idea or report in detail. |
| 53 | + - type: textarea |
| 54 | + id: notes |
| 55 | + attributes: |
| 56 | + label: Additional Notes |
| 57 | + description: Any extra information, context, or follow-up links (like forum discussions). |
| 58 | + placeholder: Add any additional notes here. |
| 59 | + - type: markdown |
| 60 | + attributes: |
| 61 | + value: | |
| 62 | + --- |
| 63 | + #### Project Guidance |
| 64 | +
|
| 65 | + - Please be patient: this is a large open source project overseen by a mix of volunteers and non-volunteers, and everyone is ultimately busy. |
| 66 | + - 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. |
| 67 | + - 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!) |
| 68 | +
|
| 69 | + #### Pro Tip: Want to help even more? |
| 70 | +
|
| 71 | + - Look for areas where you can assist - even seemingly unrelated areas - as doing so frees up resources for your favorite topics and ideas. |
| 72 | + - Submit a proposed change that addresses your issue as a pull request. |
| 73 | + - Participate in discussions on other unresolved [submitted ideas ("issues")](https://github.com/nextcloud/documentation/issues) to help move them forward. |
| 74 | + - Post a comment or review on someone else's [proposed change ("pull request")](https://github.com/nextcloud/documentation/pulls) to help move it along. |
| 75 | +
|
| 76 | + --- |
| 77 | + Thank you for taking the time to help us make Nextcloud documentation better! |
0 commit comments