Skip to content

Commit 3cb03ad

Browse files
Clarify forced redirects (#10577)
* Clarify forced redirects * Update docs/user/user-defined-redirects.rst Co-authored-by: Anthony <[email protected]> * Fix lint --------- Co-authored-by: Anthony <[email protected]>
1 parent 9f5fead commit 3cb03ad

File tree

1 file changed

+8
-10
lines changed

1 file changed

+8
-10
lines changed

docs/user/user-defined-redirects.rst

+8-10
Original file line numberDiff line numberDiff line change
@@ -25,19 +25,17 @@ the bad user experience of a 404 page is usually best to avoid.
2525
A guide to deprecating features and other topics in a documentation.
2626

2727

28-
Special features
29-
----------------
30-
31-
- By default, redirects are followed only if the requested page doesn't exist
32-
(*404 File Not Found* error).
33-
If you need to apply a redirect for files that exist,
34-
**This option is only available on some plan levels**.
35-
Please ask support if you need it for some reason.
36-
- :ref:`user-defined-redirects:page redirects` and :ref:`user-defined-redirects:exact redirects`
28+
Limitations
29+
-----------
30+
31+
- By default, redirects only apply on pages that don't exist.
32+
**Forced redirects** allow you to apply redirects on existing pages,
33+
but incur a small performance penalty, so aren't enabled by default.
34+
You can ask for them to be enabled via support.
35+
- Only :ref:`user-defined-redirects:page redirects` and :ref:`user-defined-redirects:exact redirects`
3736
can redirect to URLs outside Read the Docs,
3837
just include the protocol in ``To URL``, e.g ``https://example.com``.
3938

40-
4139
Built-in redirects
4240
------------------
4341

0 commit comments

Comments
 (0)