How to Manage Latest Versions with Pretty URLs - Fluid Topics - How To

Product
Fluid Topics
Category
How To
Target Audience
public

How to Manage Latest Versions with Pretty URLs

Business Need

Provide users with stable links to the documentation of the latest version of their product.

Overview of the Solution

Content administrators tag documentation with metadata so that users know which product version they are reading about. By defining a Pretty URL template based on this metadata, it is possible to create permanent links that always point to the latest version of the product documentation.

Procedure

1. Create a Pretty URL template for the latest version of the documents uploaded to the portal.

   - Add a template.
   - Add a metadata requirement.

2. Create a Pretty URL template for all the other versions of the documents. This is similar to Step 1, but without the metadata requirement.

Examples

Creating New Pretty URL Templates

Documents use the {version} metadata, and the latest product version is 3.10. Follow these steps to create two Pretty URL templates:

   - A template for version 3.10, where the Pretty URL will be /r/<document_title>/latest_version.
   - A template for all previous versions, where the Pretty URL will be /r/<document_title>/<product_version>.

  1. Select the Pretty URL menu item in the Knowledge Hub section of the Administration menu.
  2. Select Add Template and enter the template for the latest verion: {ft:title}/latest_version.
  3. Select Add metadata requirement.
  4. Select version in the Require this metadata menu.
  5. Select 3.10 in the With this value menu.
  6. Select Save.
  7. Select Add Template.
  8. Define the template for all other versions: {ft:title}/{version}.
  9. Select Save.

After reprocessing, the Pretty URL for all documents about the 3.10 product version will be /r/<document_title>/latest_version, while the Pretty URL for all previous versions will be /r/<document_title>/<product_version>.

All publish jobs are paused when reprocessing.

Updating the Latest Version Pretty URL Template

A new product version - 3.11. - has been released, along with its documentation. Follow these steps to update the latest version Pretty URL template accordingly.

  1. Select the Pretty URL menu item in the Knowledge Hub section of the Administration menu.
  2. Delete the criteria for the latest version.
  3. Select Add metadata requirement.
  4. Select version in the Require this metadata menu.
  5. Select 3.11 in the With this value menu.
  6. Select Save.

After reprocessing, the Pretty URL for all documents about the 3.11 product version will be /r/<document_title>/latest_version, while the Pretty URL for the 3.10 version will be /r/<document_title>/3.10.

All publish jobs are paused when reprocessing.