2018-07-17 08:06:28 -04:00
|
|
|
<!--See the general Documentation guidelines https://docs.gitlab.com/ee/development/documentation/index.html -->
|
2016-09-01 03:42:18 -04:00
|
|
|
|
|
|
|
## What does this MR do?
|
|
|
|
|
2018-03-27 03:41:15 -04:00
|
|
|
<!-- Briefly describe what this MR is about -->
|
|
|
|
|
|
|
|
## Related issues
|
|
|
|
|
|
|
|
<!-- Mention the issue(s) this MR closes or is related to -->
|
|
|
|
|
|
|
|
Closes
|
2016-09-01 03:42:18 -04:00
|
|
|
|
|
|
|
## Moving docs to a new location?
|
|
|
|
|
2018-03-27 03:41:15 -04:00
|
|
|
Read the guidelines:
|
2018-07-17 08:06:28 -04:00
|
|
|
https://docs.gitlab.com/ee/development/documentation/#changing-document-location
|
2016-09-01 03:42:18 -04:00
|
|
|
|
2018-03-27 03:41:15 -04:00
|
|
|
- [ ] Make sure the old link is not removed and has its contents replaced with
|
|
|
|
a link to the new location.
|
2016-09-01 03:42:18 -04:00
|
|
|
- [ ] Make sure internal links pointing to the document in question are not broken.
|
2018-07-17 08:06:28 -04:00
|
|
|
- [ ] 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-03-27 03:41:15 -04:00
|
|
|
to the new document if there are any Disqus comments on the old document thread.
|
2018-07-17 08:06:28 -04:00
|
|
|
- [ ] 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-01-16 04:20:39 -05:00
|
|
|
- [ ] Ping one of the technical writers for review.
|
2018-03-27 03:41:15 -04:00
|
|
|
|
|
|
|
/label ~Documentation
|