Setting Up a Product’s Help Hub

Each product has a help hub of its own: a page that introduces the product and gathers its published content in one place. A hub has three parts:

  1. Introduction: A short description of the product, set on the Config page.
  2. Platform output: Links to the product's Release Notes and QA Test Scenarios pages, once those pages exist.
  3. Documentation: A list of the product's help articles.
A product's help hub page with its introduction marked A, its Platform output section marked B and its Documentation section marked C

Titles in the hub's lists are shown exactly as written, including characters such as & and <.

To build a product's help hub:

1. Click Config

The sidebar with Config marked

2. In the product's Help hub introduction box, enter a short introduction of up to 600 characters. The box is optional

The Config page with a product's Help hub introduction box marked

3. Click Create or refresh the hub page. The platform builds the product's hub with its introduction, its Platform output section and its Documentation section

The Config page with the Create or refresh the hub page button marked

If the introduction is left blank, the hub says "Release notes, help articles and QA scenarios for [product name], drafted by Veliose from the product's changes and reviewed by a person before they are published.", with the product's name in place of [product name].

The default product

One product is the default. The dashboard opens on the default product until a person chooses another in the Product picker.

On the Config page, the default product is marked (default product) for anyone who is not signed in. When signed in, the product's heading shows · default instead.

The Config page viewed without signing in, with the (default product) label beside the default product marked
The Config page viewed while signed in, with · default in the default product's heading marked

Important: The default product must stay active and cannot be switched off. The Config page explains: "This is the default product, which the dashboard opens on, so it must stay active."