Beta version of the new documentation.

Knowledge Base Settings

The settings for the knowledge base functionality are located in the section Global Settings → Knowledge Base. Within these settings, you can enable the Knowledge Base module, manage article types, and manage keywords for knowledge base articles.

  • Enable the Knowledge Base module – Enabling this gives you access to the knowledge base functionality and also unlocks additional settings for the Knowledge Base. Disabling it will disable the Knowledge Base module, including its associated functionality. Data will not be deleted upon disabling; it will simply no longer be viewable

Types

Types are used to categorize articles in the Knowledge Base. The list includes the following default types:

  • Known Issue
  • Insight
  • Guide

You can edit, disable, or add translations to these items in the active languages, and assign a color to them as needed. Created types can be disabled, but not deleted. Disabling a type will prevent it from being offered when creating a new article; however, it will remain active for articles that had that type selected before it was disabled.

Figure: Global settings for knowledge base article types

You can expand the type list with custom types by clicking the “+ Add” button. After clicking, a new row will be created in the list with fields for entering the type name in the languages that are enabled in Global Settings → Language Settings.

Image: Adding a new article type

A type can only be deleted before saving by clicking the “” icon in the “Status” column. After saving, a type can only be deactivated using the toggle switch in the “Status” column. To deactivate a type, set the toggle switch to the “Off” position . By clicking the square in the “” column, “Color” of the type, you assign a color that will be used to display the name of that type in the list of articles.

Image: Dialog box for setting the article type color

To confirm your color selection, click the Save button in the color selection modal window. To save the type settings, click the Save button in the knowledge base settings.

Keywords for knowledge base articles

Keywords make it easier to identify an article in the Knowledge Base at. You can use keywords to search for specific articles.

Image: List of keywords for knowledge base articles

Keywords are entered directly when creating an article. This section contains a list of all keywords used throughout the knowledge base (they are added gradually as the words are used in articles). To delete a keyword, select the Delete option from the context menu of the keyword row. Deleting a keyword removes it from all articles. A keyword is automatically deleted when it is not used in any article.

Image: Button for deleting a keyword in the context menu