Plans supporting article settings updates for the knowledge base site
Free | Professional | Business | Enterprise |
---|---|---|---|
Category manager
You can access the category manager by following the below steps,
From the Knowledge base portal, go to Settings > Knowledge base site > Article settings and SEO > Article settings.
You can find Category manager. It has four options to access:
Show the first hierarchical level of categories
This option enables the first-level subcategory/article to appear by default in each main category.
On Category manager, you can find the Show first hierarchical level of categories toggle.
When toggled OFF, only the first level of the first main category is expanded by default in the knowledge base.
When toggled ON, the first level of each main category is expanded by default in the knowledge base.
Automatically mark article status
To automatically change the article status in the Knowledge base site when the article is published. This also applies to the category page.
On Category manager, you can find the Automatically mark article status toggle.
NOTE
The toggle is disabled by default.
When toggled on and you publish an article, a highlighted status tag (New/Updated) appears automatically next to the article name in the left navigation panel of the Knowledge base site.
For example,
When a new article is published, the New tag appears next to the article name in the left navigation panel of the Knowledge base site.Similarly, when an article is forked for editing and published, Updated appears next to the article name in the left navigation panel of the Knowledge base site.
When toggled off, no tags appear by default when you publish an article. You can only add it manually.
How to change the status indicator tag validity?
By default, the Article status Indicator tag appears for 30 days in the knowledge base. However, you can change the validity at the individual article level.
Go to the desired article in the Documentation editor.
Click Article settings > Status indicator.
Enter the desired days in the Show article status for field. You can set it from 1 to 90 days based on your requirements.
The article status is not updated automatically when the toggle is turned off. The team account should update manually.
Changing New and Updated status texts
You can change the text of the New and Updated status.
From the knowledge base portal, go to Settings > Knowledge base portal > Localization & Workspaces > Localization variables.
Under Category manager, type in the desired text in the respective (New/Updated) field and click Save.
How to turn off the Updated tag shown in the articles on the Knowledge base site?
When you fork an article for editing and publish it, the Updated tag is added to the article name in the left navigation pane of the Knowledge base site.
If you do not want the Updated tag, you can turn it off.
From the Knowledge base portal, go to Settings > Knowledge base site > Article settings and SEO > Article settings.
In Category manager, turn off the Automatically mark article status toggle.
How to set the article status indicator manually?
Navigate to the desired article in the Knowledge base portal.
Click the Article settings icon on the top right, and a blade window appears on the right.
Click on the Status indicator and select the checkbox of the desired status. Enter the number of days you want the status to be visible on the Knowledge base site.
Click Save on the bottom right.
(or)
Setting up status indicator for multiple articles
You can set the status indicator for multiple articles with the help of the All article feature.
From the knowledge base portal, go to All articles, and the All articles overview page appears.
Hover the mouse pointer over the desired article(s) you want to change the status and select the checkbox of the respective article(s).
Click the Status indicator option on the top and select the checkbox of the desired status.
Click Apply.
Custom status indicator
You can add a custom status indicator for your article. This status is visible only on the knowledge base site and not in the knowledge base portal.
For example, you want to show the end-users that an article is only for Beta users. You can add the custom status indicator as Beta.
Enable/disable the custom status indicator
The custom status indicator is enabled by default. You can enable/disable it as per your requirements.
From the knowledge base portal, go to Settings > Knowledge base site > Article settings & SEO > Article settings.
Under Category manager, turn on/off the Custom status indicator toggle to enable/disable it.
Choosing a background color for the custom status indicator
You can choose a Background color for the custom status indicator.
From the knowledge base portal, go to Settings > Knowledge base site > Article settings & SEO > Article settings.
Under Category manager, you can find the Custom status indicator.
Click on the color option just below the toggle.
Select a color from the color picker or enter a hex, RGB, or HSL color code and click on ☑ icon.
You can also view a preview by hovering the mouse over the eye icon next to the Background color.
Adding a custom status indicator for an article
Custom status indicators can be added only manually.
From the knowledge base portal, navigate to the desired article.
Click the Article settings icon on the top right, and a blade window appears on the right.
Click Status indicator and select the checkbox of the Custom. Enter the number of days you want the status to be visible on the Knowledge base site.
Click Save.
(or)
Setting up custom status indicator for multiple articles
You can set the status indicator for multiple articles with the help of the All articles feature.
From the knowledge base portal, go to Content tools > All articles, and the All articles overview page appears.
Hover the mouse pointer over the desired article(s) you want to change the status and select the checkbox of the respective article(s).
Click the Status indicator option on the top and select the checkbox of the Custom status.
Click Apply.
NOTE
If the Custom status indicator toggle is turned off, the custom status indicator tag in the Knowledge base site is removed from the article(s).
Bubble up status
What is the Bubble up status?
The Bubble up status lets readers view which categories have been updated with the latest articles. This feature helps you notify the readers about new and updated articles using a number bubble in the category manager.
When there is no bubble up status for a category, readers find new and updated articles only by opening the category in the left navigation pane (category manager) and viewing the status indicator tags next to the article. Thus, notifying the readers about the latest articles can be easy with this feature.
How to enable the Bubble up status in my project?
NOTE
This feature is enabled by default for all the projects created after 24th September 2022.
From the knowledge base portal, go to Settings > Knowledge base site > Article settings and SEO > Article settings.
Under Category manager, toggle the Show bubble up status option to On.
To disable the Bubble up status, toggle the Show bubble up status option to Off.
Where does the Bubble up status appear?
The count of the articles in New, Updated, and Custom statuses appears next to the category name.
This applies to all categories: Folder, Index, and Page.
The Bubble up status also appears in both categories and subcategories.
How long does the bubble up status appear?
The bubble up status disappears when the status indicator disappears from the article (i.e., the time limit for the article status indicator visibility has expired).
It will appear until the respective category/subcategory contains any article with the article status indicator (New/Updated/Custom).
Bubble up status will not disappear when a reader clicks on it.
How to localize the variables text that appears in the Category Manager?
You can localize the below text that appears on the Category manager (Left navigation pane).
No matching results found
Filter
New
Updated
Custom
Deprecated
Go to Settings > Knowledge base portal > Localization & Workspaces > Localization variables.
Select the desired language in the Select language section.
Expand the Category manager section.
Update the desired text.
NOTE
By default, the variable texts are localized to the respective language.
Click Save.
NOTE