2021-08-09 03:10:10 +00:00
|
|
|
<!--
|
|
|
|
|
See the general Documentation guidelines https://docs.gitlab.com/ee/development/documentation/
|
|
|
|
|
Use this description template for changing documentation location. For new documentation or
|
|
|
|
|
updates to existing documentation, use the Documentation.md template.
|
|
|
|
|
-->
|
2018-08-16 09:30:04 +00:00
|
|
|
|
|
|
|
|
## What does this MR do?
|
|
|
|
|
|
|
|
|
|
<!-- Briefly describe what this MR is about -->
|
|
|
|
|
|
|
|
|
|
## Related issues
|
|
|
|
|
|
2021-02-08 15:09:38 +00:00
|
|
|
<!-- Link related issues below. -->
|
2018-08-16 09:30:04 +00:00
|
|
|
|
|
|
|
|
## Moving docs to a new location?
|
|
|
|
|
|
|
|
|
|
Read the guidelines:
|
2020-09-29 18:09:52 +00:00
|
|
|
https://docs.gitlab.com/ee/development/documentation/index.html#move-or-rename-a-page
|
2018-08-16 09:30:04 +00:00
|
|
|
|
|
|
|
|
- [ ] Make sure the old link is not removed and has its contents replaced with
|
|
|
|
|
a link to the new location.
|
|
|
|
|
- [ ] Make sure internal links pointing to the document in question are not broken.
|
|
|
|
|
- [ ] Search and replace any links referring to old docs in GitLab Rails app,
|
2020-10-14 12:08:58 +00:00
|
|
|
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-08-16 09:30:04 +00:00
|
|
|
to the new document if there are any Disqus comments on the old document thread.
|
|
|
|
|
- [ ] Update the link in `features.yml` (if applicable)
|
2020-10-14 12:08:58 +00:00
|
|
|
- [ ] Assign one of the technical writers for review.
|
2018-08-16 09:30:04 +00:00
|
|
|
|
2021-08-09 03:10:10 +00:00
|
|
|
/label ~documentation ~"Technical Writing"
|
