Skip to content

Add detail to redirects page #2969

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Jul 17, 2017
Merged

Add detail to redirects page #2969

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
557cf17
Add detail to redirects page
kerrywatson1 Jun 23, 2017
e4ddac9
Fix typo
kerrywatson1 Jun 23, 2017
6a0f5d9
Merge branch 'master' into patch-1
ericholscher Jul 17, 2017
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 21 additions & 5 deletions docs/user-defined-redirects.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,10 +1,25 @@
User-defined Redirects
======================

You can set up redirects for a project on the project's Admin page.
You can set up redirects for a project in your project dashboard's Redirects page.

Quick Summary
-------------

* Log into your Readthedocs.com Admin account.
* From your dashboard, select the project on which you wish to add redirects.
* From the project's top navigation bar, select the Admin tab.
* From the left navigation menu, select Redirects.
* In the form box "Redirect Type" select the type of redirect you want. See below for detail.
* Depending on the redirect type you select, enter FROM and/or TO URL as needed.
* When finished, click the SUBMIT Button.

Your redirects will be effective immediately.

Redirect Types
--------------
Prefix Redirects
----------------
~~~~~~~~~~~~~~~~

The most useful and requested feature of redirects was when migrating to Read the Docs from an old host.
You would have your docs served at a previous URL,
Expand All @@ -30,7 +45,7 @@ Your users query would now redirect in the following manner::
Where ``en`` and ``latest`` are the default language and version values for your project.

Page Redirects
--------------
~~~~~~~~~~~~~~

A more specific case is when you move a page around in your docs.
The old page will start 404'ing,
Expand All @@ -48,7 +63,7 @@ Note that the ``/`` at the start doesn't count the ``/en/latest``,
but just the user-controlled section of the URL.

Exact Redirects
---------------
~~~~~~~~~~~~~~~

If you're redirecting from an old host AND you aren't maintaining old paths for your
documents, a Prefix Redirect won't suffice and you'll need to create *Exact Redirects*
Expand All @@ -73,7 +88,7 @@ Note that you should insert the desired language for "en" and version for "lates
achieve the desired redirect.

Sphinx Redirects
----------------
~~~~~~~~~~~~~~~~

We also support redirects for changing the type of documentation Sphinx is building.
If you switch between *HTMLDir* and *HTML*, your URL's will change.
Expand All @@ -90,3 +105,4 @@ This means that redirects will only happen in the case of a *404 File Not Found*

In the future we might implement redirect logic in Javascript,
but this first version is only implemented in the 404 handlers.