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

17 lines
972 B
Markdown
Raw Normal View History

2016-11-03 12:29:30 +05:30
See the general Documentation guidelines http://docs.gitlab.com/ce/development/doc_styleguide.html
2016-09-29 09:46:39 +05:30
## What does this MR do?
(briefly describe what this MR is about)
## Moving docs to a new location?
See the guidelines: http://docs.gitlab.com/ce/development/doc_styleguide.html#changing-document-location
- [ ] 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, specifically under the `app/views/` directory.
2018-03-17 18:26:18 +05:30
- [ ] Make sure to add [`redirect_from`](https://docs.gitlab.com/ee/development/doc_styleguide.html#redirections-for-pages-with-disqus-comments) to the new document if there are any Disqus comments on the old document thread.
2016-09-29 09:46:39 +05:30
- [ ] If working on CE, submit an MR to EE with the changes as well.
2018-03-17 18:26:18 +05:30
- [ ] Ping one of the technical writers for review.