centersl/docker-docs
1
0
Fork 0
mirror of https://github.com/docker/docs.git synced 2026-03-27 14:28:47 +07:00
Code Issues Packages Projects Releases Wiki Activity

Reserve "/go/" URL prefix for redirect pages

Browse Source 
This page is used to reserve the "/go/" URL/path for redirecting purposes. This
page is not published, and should not be visible on the documentation website.

Use the `/go/` URL prefix to provide "vanity" URLs linking to the documentation.
These URLs can be used in (for example) the `docker` CLI to provide a short,
permanent link to refer to a topic in the documentation.

Having a fixed `/go/` URL allows you to redirect the URL to the most current
location in the documentation for a given topic, which may evolve over time.

For example, the `docker` CLI can output `https://docs.docker.com/go/some-topic`
in its help output, which can be redirected to elsewhere in the documentation,
using the `redirect_from` metadata field in the target page.

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
This commit is contained in:
Sebastiaan van Stijn
2020-10-02 12:51:09 +02:00
parent c3bcd2bc6c
commit 068a26a47e
1 changed files with 19 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

19
go/about.md Normal file
View File

@@ -0,0 +1,19 @@
---
description: Docker documentation redirect URLs
title: Docker documentation redirect URLs
published: false
---
This page is used to reserve the "/go/" URL/path for redirecting purposes. This
page is not published, and should not be visible on the documentation website.
Use the `/go/` URL prefix to provide "vanity" URLs linking to the documentation.
These URLs can be used in (for example) the `docker` CLI to provide a short,
permanent link to refer to a topic in the documentation.
Having a fixed `/go/` URL allows you to redirect the URL to the most current
location in the documentation for a given topic, which may evolve over time.
For example, the `docker` CLI can output `https://docs.docker.com/go/some-topic`
in its help output, which can be redirected to elsewhere in the documentation,
using the `redirect_from` metadata field in the target page.