2019-01-11 03:26:32 +00:00
|
|
|
<!--
|
2018-08-16 09:30:04 +00:00
|
|
|
|
2019-01-23 05:27:44 +00:00
|
|
|
* Use this issue template for suggesting new docs or updates to existing docs.
|
2019-01-11 03:26:32 +00:00
|
|
|
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/
|
2018-08-16 09:30:04 +00:00
|
|
|
|
2019-01-11 03:26:32 +00:00
|
|
|
* For information about documentation content and process, see
|
|
|
|
https://docs.gitlab.com/ee/development/documentation/ -->
|
2018-08-16 09:30:04 +00:00
|
|
|
|
2019-01-11 03:26:32 +00:00
|
|
|
### Type of issue
|
2018-08-16 09:30:04 +00:00
|
|
|
|
2019-02-07 21:02:43 +00:00
|
|
|
<!-- Un-comment the lines for the applicable doc issue type and delete the others. -->
|
|
|
|
|
2019-02-08 02:23:48 +00:00
|
|
|
<!-- /label ~"docs:fix"
|
2019-02-07 21:02:43 +00:00
|
|
|
Correction or clarification needed. -->
|
|
|
|
|
2019-02-08 02:23:48 +00:00
|
|
|
<!-- /label ~"docs:new"
|
2019-02-07 21:02:43 +00:00
|
|
|
New doc needed to cover a new topic or use case. -->
|
|
|
|
|
2019-02-08 02:23:48 +00:00
|
|
|
<!-- /label ~"docs:improvement"
|
2019-02-07 21:02:43 +00:00
|
|
|
Improving an existing doc; e.g. adding a diagram, adding or rewording text, resolving redundancies, cross-linking, etc. -->
|
|
|
|
|
2019-02-08 02:23:48 +00:00
|
|
|
<!-- /label ~"docs:revamp"
|
2019-02-07 21:02:43 +00:00
|
|
|
Review a page or group of pages in order to plan and implement major improvements/rewrites. -->
|
|
|
|
|
2019-02-08 02:23:48 +00:00
|
|
|
<!-- /label ~"docs:other"
|
2019-02-07 21:02:43 +00:00
|
|
|
Anything else. -->
|
|
|
|
|
2019-01-11 03:26:32 +00:00
|
|
|
### Problem to solve
|
2018-08-16 09:30:04 +00:00
|
|
|
|
2019-01-23 05:27:44 +00:00
|
|
|
<!-- Include the following detail as necessary:
|
2019-01-17 18:17:37 +00:00
|
|
|
* 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 other ideas or requests?
|
|
|
|
-->
|
2018-08-16 09:30:04 +00:00
|
|
|
|
2019-01-11 03:26:32 +00:00
|
|
|
### Further details
|
2018-08-16 09:30:04 +00:00
|
|
|
|
2019-01-17 18:17:37 +00:00
|
|
|
<!--
|
|
|
|
* Any concepts, procedures, reference info we could add to make it easier to successfully use GitLab?
|
|
|
|
* Include use cases, benefits, and/or goals for this work.
|
|
|
|
* If adding content: What audience is it intended for? (What roles and scenarios?)
|
2019-01-23 05:27:44 +00:00
|
|
|
For ideas, see personas at https://design.gitlab.com/research/personas or the persona labels at
|
|
|
|
https://gitlab.com/groups/gitlab-org/-/labels?utf8=%E2%9C%93&subscribed=&search=persona%3A
|
2019-01-17 18:17:37 +00:00
|
|
|
-->
|
2018-08-16 09:30:04 +00:00
|
|
|
|
2019-01-11 03:26:32 +00:00
|
|
|
### Proposal
|
2018-08-16 09:30:04 +00:00
|
|
|
|
2019-01-17 18:17:37 +00:00
|
|
|
<!-- Further specifics for how can we solve the problem. -->
|
2018-08-16 09:30:04 +00:00
|
|
|
|
2019-01-11 03:26:32 +00:00
|
|
|
### Who can address the issue
|
2018-08-16 09:30:04 +00:00
|
|
|
|
2019-01-11 03:26:32 +00:00
|
|
|
<!-- What if any special expertise is required to resolve this issue? -->
|
2018-08-16 09:30:04 +00:00
|
|
|
|
2019-01-11 03:26:32 +00:00
|
|
|
### Other links/references
|
2018-08-16 09:30:04 +00:00
|
|
|
|
2019-01-11 03:26:32 +00:00
|
|
|
<!-- E.g. related GitLab issues/MRs -->
|
2018-08-16 09:30:04 +00:00
|
|
|
|
|
|
|
/label ~Documentation
|