parent
7c02d0cff3
commit
729d155415
|
@ -1,16 +1,29 @@
|
|||
See the general Documentation guidelines http://docs.gitlab.com/ce/development/doc_styleguide.html
|
||||
<!--See the general Documentation guidelines https://docs.gitlab.com/ce/development/writing_documentation.html -->
|
||||
|
||||
## What does this MR do?
|
||||
|
||||
(briefly describe what this MR is about)
|
||||
<!-- Briefly describe what this MR is about -->
|
||||
|
||||
## Related issues
|
||||
|
||||
<!-- Mention the issue(s) this MR closes or is related to -->
|
||||
|
||||
Closes
|
||||
|
||||
## Moving docs to a new location?
|
||||
|
||||
See the guidelines: http://docs.gitlab.com/ce/development/doc_styleguide.html#changing-document-location
|
||||
Read the guidelines:
|
||||
https://docs.gitlab.com/ce/development/writing_documentation.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 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.
|
||||
- [ ] 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.
|
||||
- [ ] If working on CE, submit an MR to EE with the changes as well.
|
||||
- [ ] Search and replace any links referring to old docs in 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/ce/development/writing_documentation.html#redirections-for-pages-with-disqus-comments)
|
||||
to the new document if there are any Disqus comments on the old document thread.
|
||||
- [ ] If working on CE and the `ee-compat-check` jobs fails, submit an MR to EE
|
||||
with the changes as well (https://docs.gitlab.com/ce/development/writing_documentation.html#cherry-picking-from-ce-to-ee).
|
||||
- [ ] Ping one of the technical writers for review.
|
||||
|
||||
/label ~Documentation
|
||||
|
|
Loading…
Reference in New Issue