diff options
| author | Achilleas Pipinellis <axil@gitlab.com> | 2018-05-09 11:09:07 +0000 |
|---|---|---|
| committer | Achilleas Pipinellis <axil@gitlab.com> | 2018-05-09 11:09:07 +0000 |
| commit | c1c934ca5bd6a623baf1046814c2e3861720b578 (patch) | |
| tree | 106d08c239e6584f05b3ebbfb661b9d819b9b1f1 | |
| parent | ec7f1d12a9ddf9d8f36b13697c145401e9c34dc3 (diff) | |
| parent | 2424e309a174a30f0aa9198a3c967b1907612f98 (diff) | |
| download | gitlab-ce-c1c934ca5bd6a623baf1046814c2e3861720b578.tar.gz | |
Merge branch 'docs-document-redirect-to' into 'master'
Docs: document the redirect_to method
See merge request gitlab-org/gitlab-ce!18788
| -rw-r--r-- | doc/development/writing_documentation.md | 13 |
1 files changed, 13 insertions, 0 deletions
diff --git a/doc/development/writing_documentation.md b/doc/development/writing_documentation.md index fb7da82977b..1c41fc7611f 100644 --- a/doc/development/writing_documentation.md +++ b/doc/development/writing_documentation.md @@ -205,6 +205,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, |