summaryrefslogtreecommitdiff
path: root/doc/development/writing_documentation.md
diff options
context:
space:
mode:
authorMarcia Ramos <virtua.creative@gmail.com>2018-05-07 14:26:38 -0300
committerMarcia Ramos <virtua.creative@gmail.com>2018-05-07 14:26:38 -0300
commit2424e309a174a30f0aa9198a3c967b1907612f98 (patch)
tree530e673e1f6674db4073aa0f346f9b1006556a70 /doc/development/writing_documentation.md
parent8ba7b602c8adc57cff546caaf51527ce49e7da0f (diff)
downloadgitlab-ce-2424e309a174a30f0aa9198a3c967b1907612f98.tar.gz
document the redirect_to method
Diffstat (limited to 'doc/development/writing_documentation.md')
-rw-r--r--doc/development/writing_documentation.md13
1 files changed, 13 insertions, 0 deletions
diff --git a/doc/development/writing_documentation.md b/doc/development/writing_documentation.md
index 9bca4637830..f4f8167b45f 100644
--- a/doc/development/writing_documentation.md
+++ b/doc/development/writing_documentation.md
@@ -201,6 +201,19 @@ Things to note:
built-in help page, that's why we omit it in `git grep`.
- Use the checklist on the documentation MR description template.
+#### Alternative redirection method
+
+Alternatively to the method described above, you can simply replace the content
+of the old file with a frontmatter containing a redirect link:
+
+```yaml
+---
+redirect_to: '../path/to/file/README.md'
+---
+```
+
+It supports both full and relative URLs, e.g. `https://docs.gitlab.com/ee/path/to/file.html`, `../path/to/file.html`, `path/to/file.md`. Note that any `*.md` paths will be compiled to `*.html`.
+
### Redirections for pages with Disqus comments
If the documentation page being relocated already has any Disqus comments,