Reserve "/go/" URL prefix for redirect pages #11460
Conversation
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>
|
@usha-mandya ptal @chris-crone @stephen-turner @nebuk89 FYI; you may have an interest in this as well |
|
Deploy preview for docsdocker ready! Built with commit 068a26a |
|
I may have to do some experimenting on how to redirect to specific anchors on a page (which may need a custom redirect page in this directory instead of using |
Yes, we can discuss this during our next sync and review some ideas on adding anchors from the UI and CLI. @nebuk89 Do you want to take a quick look before I merge the PR? |
|
@nebuk89 gave me his "LCTM" (looks cool to me) on slack; I'll merge this one 👍 |
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
dockerCLI 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 currentlocation in the documentation for a given topic, which may evolve over time.
For example, the
dockerCLI can outputhttps://docs.docker.com/go/some-topicin its help output, which can be redirected to elsewhere in the documentation,
using the
redirect_frommetadata field in the target page.