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

29 lines
1.2 KiB
Markdown
Raw Normal View History

2019-05-05 18:10:48 +05:30
<!--See the general Documentation guidelines https://docs.gitlab.com/ee/development/documentation/ -->
<!-- Use this description template for changing documentation location. For new docs or updates to existing docs, use the "Documentation" template -->
## What does this MR do?
<!-- Briefly describe what this MR is about -->
## Related issues
2021-03-11 19:13:27 +05:30
<!-- Link related issues below. -->
2019-05-05 18:10:48 +05:30
## Moving docs to a new location?
Read the guidelines:
2021-01-03 14:25:43 +05:30
https://docs.gitlab.com/ee/development/documentation/index.html#move-or-rename-a-page
2019-05-05 18:10:48 +05:30
- [ ] 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,
2021-01-03 14:25:43 +05:30
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)
2019-05-05 18:10:48 +05:30
to the new document if there are any Disqus comments on the old document thread.
- [ ] Update the link in `features.yml` (if applicable)
2021-01-03 14:25:43 +05:30
- [ ] Assign one of the technical writers for review.
2019-05-05 18:10:48 +05:30
2019-12-21 20:55:43 +05:30
/label ~documentation