2019-01-11 03:26:32 +00:00
|
|
|
<!--
|
2018-08-16 09:30:04 +00:00
|
|
|
|
2019-01-11 03:26:32 +00:00
|
|
|
* 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/
|
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-01-17 18:10:07 +00:00
|
|
|
Add the relevant label:
|
|
|
|
|
|
|
|
- `docs:fix` - Correction or clarification needed.
|
|
|
|
- `docs:new` - New doc needed to cover a new topic or use case.
|
|
|
|
- `docs:improvement` - Improving an existing doc; e.g. adding a diagram, adding or rewording text, resolving redundancies, cross-linking, etc.
|
|
|
|
- `docs:revamp` - Review a page or group of pages in order to plan and implement major improvements/rewrites.
|
|
|
|
- `docs:other` - Anything else.
|
|
|
|
|
2019-01-11 03:26:32 +00:00
|
|
|
### Problem to solve
|
2018-08-16 09:30:04 +00:00
|
|
|
|
2019-01-11 03:26:32 +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 concepts, procedures, reference info we could add to make it easier to successfully use GitLab?
|
|
|
|
Any other ideas or requests? -->
|
2018-08-16 09:30:04 +00:00
|
|
|
|
2019-01-11 03:26:32 +00:00
|
|
|
### Target audience
|
2018-08-16 09:30:04 +00:00
|
|
|
|
2019-01-11 03:26:32 +00:00
|
|
|
<!-- Who would benefit from this information? -->
|
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-11 03:26:32 +00:00
|
|
|
<!-- Include use cases, benefits, and/or goals for this work. -->
|
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-11 03:26:32 +00:00
|
|
|
<!-- 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
|