From cbf9ee55aed67d9dcd2fda277d0375f73b5d7089 Mon Sep 17 00:00:00 2001 From: Tana M Berry Date: Tue, 25 Mar 2025 11:38:17 -0500 Subject: [PATCH] root: new issue template for Docs (#13659) * new issue template for Docs * added note about a PR * Update .github/ISSUE_TEMPLATE/docs_issue.md Co-authored-by: Marc 'risson' Schmitt Signed-off-by: Tana M Berry * Update .github/ISSUE_TEMPLATE/docs_issue.md Signed-off-by: Marc 'risson' Schmitt --------- Signed-off-by: Tana M Berry Signed-off-by: Marc 'risson' Schmitt Co-authored-by: Tana M Berry Co-authored-by: Marc 'risson' Schmitt --- .github/ISSUE_TEMPLATE/docs_issue.md | 22 ++++++++++++++++++++++ 1 file changed, 22 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/docs_issue.md diff --git a/.github/ISSUE_TEMPLATE/docs_issue.md b/.github/ISSUE_TEMPLATE/docs_issue.md new file mode 100644 index 0000000000..47eaa2a668 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/docs_issue.md @@ -0,0 +1,22 @@ +--- +name: Documentation issue +about: Suggest an improvement or report a problem +title: "" +labels: documentation +assignees: "" +--- + +**Do you see an area that can be clarified or expanded, a technical inaccuracy, or a broken link? Please describe.** +A clear and concise description of what the problem is, or where the document can be improved. Ex. I believe we need more details about [...] + +**Provide the URL or link to the exact page in the documentation to which you are referring.** +If there are multiple pages, list them all, and be sure to state the header or section where the content is. + +**Describe the solution you'd like** +A clear and concise description of what you want to happen. + +**Additional context** +Add any other context or screenshots about the documentation issue here. + +**Consider opening a PR!** +If the issue is one that you can fix, or even make a good pass at, we'd appreciate a PR. For more information about making a contribution to the docs, and using our Style Guide and our templates, refer to ["Writing documentation"](https://docs.goauthentik.io/docs/developer-docs/docs/writing-documentation). \ No newline at end of file