Commit 6d1d5e33 authored by Mike Lewis's avatar Mike Lewis

Rewrite Documentation issue template

parent 43c82b22
<!--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 --> ### Type of issue
- [ ] Follow-up from: #XXX, !YYY <!-- Mention related issues, MRs, and epics when available -->
## 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 ### Target audience
- [ ] Update existing documentation
## 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 ### Proposal
- [ ] 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
#### 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** <!-- E.g. related GitLab issues/MRs -->
<!-- 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
/label ~Documentation /label ~Documentation
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment