Redirects allow you to redirect external links coming into your ScreenSteps site to a different url. For example, if you rename the slug on a manual in your Site then you can use a redirect to point external links pointing to the old slug to the new slug. Or if you move an article from one site to another you can redirect external links to that article to the new article location.
Important: Redirects will only trigger if the article, manual or chapter you are trying to redirect from is either removed from the site or unpublished. ScreenSteps will only redirect a request if it can not find the article, chapter, or manual that is being requested.
Edit site settings
Begin by navigating to the site settings page.
Redirects settings explanation
- The id or permalink of your manual. This is the number or word that comes right after /manuals in your url.
- https://help.mysite.com/m/my-manual - use my-manual
- https://help.mysite.com/m/34 - use 34
- Chapter ID (optional): only fill in this field if you are setting up a redirect for a url that points to a chapter.
- Article ID (optional): only fill in this field if you are setting up a redirect for a url that points to an article. Only use the numeric portion of the ID.
https://help.mysite.com/m/my-manual/l/43242-my-article - use 43242
- Redirect to URL: the page you want visitors to be redirected to when the redirect is triggered.
If you are redirecting to a resource within the same site, copy and enter everything that comes after the domain on that page, e.g. /m/my-new-manual/c/142 or /s/12345/m/my-new-manual/c/142.
If you are redirecting to a url outside of the current site then use the full url, e.g. https://www.screensteps.com.
Example 1: Create a redirect for a manual
Click + Create new redirect
Enter redirect information
In this example the original url was https://help.mysite.com/m/my-manual/l/44.
When the visitor enters that url they would be redirected to https://help.mysite.com/m/another-manual/l/44.
Example 2: Redirecting a chapter
In this example the original url was https://help.mysite.com/m/452/c/553.
When the visitor enters that url they would be redirected to https://help.mysite.com/m/452/c/678.
Deleting a Redirect
To delete a redirect, click on the Delete button.
In the introduction for this article, you say that if you move an article to another manual, and you have a link to the article (say, an in-product link) that uses the old URL, the link will no longer work. But Screensteps does redirect you automatically to the correct URL if you move the article to another manual. Am I wrong about this?
@Michael - if you create the links using our Knowledge Base link dialog then the links are updated for you automatically. Those links are generated on the fly. If you have hard coded urls pointing to an article then you would need to use redirects.