debian-mirror-gitlab/.gitlab/merge_request_templates/Documentation.md

30 lines
1.3 KiB
Markdown
Raw Normal View History

2018-11-18 11:00:15 +05:30
<!--See the general Documentation guidelines https://docs.gitlab.com/ee/development/documentation/index.html -->
2016-09-29 09:46:39 +05:30
## What does this MR do?
2018-05-09 12:01:36 +05:30
<!-- Briefly describe what this MR is about -->
## Related issues
<!-- Mention the issue(s) this MR closes or is related to -->
Closes
2016-09-29 09:46:39 +05:30
## Moving docs to a new location?
2018-05-09 12:01:36 +05:30
Read the guidelines:
2018-11-18 11:00:15 +05:30
https://docs.gitlab.com/ee/development/documentation/#changing-document-location
2016-09-29 09:46:39 +05:30
2018-05-09 12:01:36 +05:30
- [ ] Make sure the old link is not removed and has its contents replaced with
a link to the new location.
2016-09-29 09:46:39 +05:30
- [ ] Make sure internal links pointing to the document in question are not broken.
2018-11-18 11:00:15 +05:30
- [ ] Search and replace any links referring to the old docs in the GitLab Rails app,
specifically under the `app/views/` and `ee/app/views` (for GitLab EE) directories.
- [ ] Make sure to add [`redirect_from`](https://docs.gitlab.com/ee/development/documentation/index.html#redirections-for-pages-with-disqus-comments)
2018-05-09 12:01:36 +05:30
to the new document if there are any Disqus comments on the old document thread.
2018-11-18 11:00:15 +05:30
- [ ] If working on CE and the `ee-compat-check` jobs fails, [submit an MR to EE
with the changes](https://docs.gitlab.com/ee/development/documentation/index.html#cherry-picking-from-ce-to-ee) as well.
2018-03-17 18:26:18 +05:30
- [ ] Ping one of the technical writers for review.
2018-05-09 12:01:36 +05:30
/label ~Documentation