Skip to content

Commit

Permalink
Add detail to redirects page
Browse files Browse the repository at this point in the history
  • Loading branch information
kerrywatson1 committed Jun 23, 2017
1 parent 2d4e004 commit 557cf17
Showing 1 changed file with 21 additions and 6 deletions.
27 changes: 21 additions & 6 deletions docs/user-defined-redirects.rst
@@ -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 @@ -92,6 +107,6 @@ In the future we might implement redirect logic in Javascript,
but this first version is only implemented in the 404 handlers.


Feature Requests
.. Feature Requests

0 comments on commit 557cf17

Please sign in to comment.