summaryrefslogtreecommitdiff
path: root/.gitlab
diff options
context:
space:
mode:
authorMike Lewis <mlewis@gitlab.com>2019-01-11 03:26:32 +0000
committerMike Lewis <mlewis@gitlab.com>2019-01-11 03:26:32 +0000
commit6d1d5e33bac508833cb7b4422e81c6e33b72e3df (patch)
tree053f3bac068de82e430a5eee9a76cca0bc8ebc36 /.gitlab
parent43c82b229907c2e8d4ca3161c9dd061fea67a486 (diff)
downloadgitlab-ce-6d1d5e33bac508833cb7b4422e81c6e33b72e3df.tar.gz
Rewrite Documentation issue template
Diffstat (limited to '.gitlab')
-rw-r--r--.gitlab/issue_templates/Documentation.md67
1 files changed, 31 insertions, 36 deletions
diff --git a/.gitlab/issue_templates/Documentation.md b/.gitlab/issue_templates/Documentation.md
index b33ed5bcaa8..663e6f33c40 100644
--- a/.gitlab/issue_templates/Documentation.md
+++ b/.gitlab/issue_templates/Documentation.md
@@ -1,54 +1,49 @@
-<!--See the general documentation guidelines https://docs.gitlab.com/ee/development/documentation -->
+<!--
-<!-- Mention "documentation" or "docs" in the issue title -->
+* Mention "documentation" or "docs" as part of the issue title
-<!-- Use this description template for new docs or updates to existing docs. -->
+* Use this description template for suggesting new docs or updates to existing docs.
+ Note: Doc work as part of feature development is covered in the Feature Request template.
+
+* For issues related to features of the docs.gitlab.com site, see
+ https://gitlab.com/gitlab-com/gitlab-docs/issues/
-<!-- Check the documentation structure guidelines for guidance: https://docs.gitlab.com/ee/development/documentation/structure.html-->
+* For information about documentation content and process, see
+ https://docs.gitlab.com/ee/development/documentation/ -->
-- [ ] Documents Feature A <!-- feature name -->
-- [ ] Follow-up from: #XXX, !YYY <!-- Mention related issues, MRs, and epics when available -->
+### Type of issue
-## New doc or update?
+- [ ] Correction or clarification needed
+- [ ] New doc or section needed
+- [ ] Rewrite of doc or section needed
+- [ ] Restructure or other broader improvements
+- [ ] Other
+
+### Problem to solve
-<!-- Mark either of these boxes: -->
+<!-- What product or feature(s) affected? What docs or doc section affected? Include links or paths.
+Is there a problem with a specific document, or a feature/process that's not addressed sufficiently in docs?
+Any concepts, procedures, reference info we could add to make it easier to successfully use GitLab?
+Any other ideas or requests? -->
-- [ ] New documentation
-- [ ] Update existing documentation
+### Target audience
-## Checklists
+<!-- Who would benefit from this information? -->
-### Product Manager
+### Further details
-<!-- Reference: https://docs.gitlab.com/ee/development/documentation/workflow.html#1-product-manager-s-role-in-the-documentation-process -->
+<!-- Include use cases, benefits, and/or goals for this work. -->
-- [ ] Add the correct labels
-- [ ] Add the correct milestone
-- [ ] Indicate the correct document/directory for this feature <!-- (ping the tech writers for help if you're not sure) -->
-- [ ] Fill the doc blurb below
+### Proposal
-#### Documentation blurb
+<!-- How can we solve the problem? -->
-<!-- Documentation template: https://docs.gitlab.com/ee/development/documentation/structure.html#documentation-template-for-new-docs -->
+### Who can address the issue
-- Doc **title**
+<!-- What if any special expertise is required to resolve this issue? -->
- <!-- write the doc title here -->
+### Other links/references
-- Feature **overview/description**
-
- <!-- Write the feature overview here -->
-
-- Feature **use cases**
-
- <!-- Write the use cases here -->
-
-### Developer
-
-<!-- Reference: https://docs.gitlab.com/ee/development/documentation/workflow.html#2-developer-s-role-in-the-documentation-process -->
-
-- [ ] Copy the doc blurb above and paste it into the doc
-- [ ] Write the tutorial - explain how to use the feature
-- [ ] Submit the MR using the appropriate MR description template
+<!-- E.g. related GitLab issues/MRs -->
/label ~Documentation