Skip to content

Commit 9fa1223

Browse files
authored
Merge pull request #2969 from kerrywatson1/patch-1
Add detail to redirects page
2 parents d14cea0 + 6a0f5d9 commit 9fa1223

File tree

1 file changed

+21
-5
lines changed

1 file changed

+21
-5
lines changed

docs/user-defined-redirects.rst

Lines changed: 21 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,25 @@
11
User-defined Redirects
22
======================
33

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

6+
Quick Summary
7+
-------------
8+
9+
* Log into your Readthedocs.com Admin account.
10+
* From your dashboard, select the project on which you wish to add redirects.
11+
* From the project's top navigation bar, select the Admin tab.
12+
* From the left navigation menu, select Redirects.
13+
* In the form box "Redirect Type" select the type of redirect you want. See below for detail.
14+
* Depending on the redirect type you select, enter FROM and/or TO URL as needed.
15+
* When finished, click the SUBMIT Button.
16+
17+
Your redirects will be effective immediately.
18+
19+
Redirect Types
20+
--------------
621
Prefix Redirects
7-
----------------
22+
~~~~~~~~~~~~~~~~
823

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

3247
Page Redirects
33-
--------------
48+
~~~~~~~~~~~~~~
3449

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

5065
Exact Redirects
51-
---------------
66+
~~~~~~~~~~~~~~~
5267

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

7590
Sphinx Redirects
76-
----------------
91+
~~~~~~~~~~~~~~~~
7792

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

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

0 commit comments

Comments
 (0)