From 2424e309a174a30f0aa9198a3c967b1907612f98 Mon Sep 17 00:00:00 2001 From: Marcia Ramos Date: Mon, 7 May 2018 14:26:38 -0300 Subject: document the redirect_to method --- doc/development/writing_documentation.md | 13 +++++++++++++ 1 file changed, 13 insertions(+) (limited to 'doc/development/writing_documentation.md') 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, -- cgit v1.2.1