Skip to content
Projects
Groups
Snippets
Help
Loading...
Help
Support
Keyboard shortcuts
?
Submit feedback
Contribute to GitLab
Sign in / Register
Toggle navigation
G
gitlab-ce
Project overview
Project overview
Details
Activity
Releases
Repository
Repository
Files
Commits
Branches
Tags
Contributors
Graph
Compare
Issues
0
Issues
0
List
Boards
Labels
Milestones
Merge Requests
0
Merge Requests
0
Analytics
Analytics
Repository
Value Stream
Wiki
Wiki
Snippets
Snippets
Members
Members
Collapse sidebar
Close sidebar
Activity
Graph
Create a new issue
Commits
Issue Boards
Open sidebar
Léo-Paul Géneau
gitlab-ce
Commits
6d1d5e33
Commit
6d1d5e33
authored
Jan 11, 2019
by
Mike Lewis
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
Rewrite Documentation issue template
parent
43c82b22
Changes
1
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
with
31 additions
and
36 deletions
+31
-36
.gitlab/issue_templates/Documentation.md
.gitlab/issue_templates/Documentation.md
+31
-36
No files found.
.gitlab/issue_templates/Documentation.md
View file @
6d1d5e33
<!--
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
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment