How do I use permalinks?

Each site and manual can have a permalink. A permalink is a string that you assign which will be used in the URL for the site or manual.

URL With IDs

If you don't set up any permalinks to your manuals or sites, then the ids for those items will be used in the url.

In the image below, the URL has IDs, and does not have permalinks.

1. Your account name.

2. The id for the site.

3. The id for the manual.

URL With IDs

In this example, we have added a screensteps permalink to our site and an integration permalink to our manual.

Same URL With Permalinks

Why Does This Matter?

Important! You don't need to use permalinks. They are completely optional.

Permalinks make your urls much more meaningful and descriptive. There are also situations where they can be very useful. Look at the following scenario:

1. We have a manual with a permalink of our_super_product.

2. We prepare to release version 2 of our super product so we have to redo the entire manual.

3. All of the links to our manual point to a manual with a permalink of our_super_product. We now want those links to go to the new manual.

4. All we do is remove the our_super_product permalink from the old manual and apply it to the new manual. All of users will now see the new manual.


Add your comment

E-Mail me when someone replies to this comment