TDX Knowledge: Add Related Articles to a KB Article

You can add Related Articles to your knowledge base article to quickly link readers to other related materials. 

Table of Contents:

• What are Related Articles?
• Guidelines for Related Articles
• Adding a Related Article
• Removing a Related Article
• Permissions and Visibility
• Troubleshoot: Related Article is Not Showing its Article Summary
   

What are Related Articles?

Adding an article to the Related Articles section is a good way to indicate that another article is relevant or related to the current article, even if it may describe a separate process or service. 

Related Articles are listed by the article title and appear on the right side of the article page beneath the Details panel. 

Guidelines for Related Articles

• We recommend you add any articles you put direct links to in the body of the article as a Related Article. 
• As an article owner, adding something to the Related Articles section can be a way to prompt other technicians and/or groups to review another article that describes a separate process or service, but is still relevant to the current article. 
  • Additionally, if you notice other technicians or teams often missing or not finding one of your team's articles, adding it as a Related Article on a more commonly used article can raise awareness to the article's existence. 
• If there is more than one Related Article, they are listed alphabetically. 
• The visibility of an article's Related Articles is dependent on the article's level of view access.
  • Internal: only Technicians can view the article's Related Articles.
  • Published-Restricted or Published-Unrestricted: Technicians and Authenticated Users can view the article's Related Articles.

Adding a Related Article

1. In the Client Portal, open the Knowledge Base and navigate to the desired Article.
   • Or you can navigate directly to the Knowledge Base Search page and search for the article.
2. Click Edit Article.
3. Click the Related Articles tab.
4. Search for the article you would like to link, either by typing in the Search field or clicking the magnifying glass.
5. Once you have selected an article to link, click Add.

Note: if you are adding more than one related article, they will be listed alphabetically on the article page. Currently, it is not possible to set the sort order yourself. 

Removing a Related Article

1. In the Client Portal, open the Knowledge Base and navigate to the desired Article.
   • Or you can navigate directly to the Knowledge Base Search page and search for the article.
2. Click Edit Article.
3. Click the Related Articles tab.
4. Click Remove for the article you wish to remove from the list.

Permissions and Visibility

The articles that are visible to a reader in the Related Articles list in TDX depend on the Related Article's security level.

• Internal articles - only TDX Technicians
  • Settings
    • Published: No, Restrict Access: Internal Article for TDX Technicians only
  •  When it's added to a Related Article list, an article will only appear on the list for TDX Technicians. Non-technicians will not have the internal article listed in any Related Articles lists. 
• Public articles - everyone who signs in to TDX to view the article
  • Settings:
    • Published: Yes, Restrict Access: Yes - All campuses must log in to view
    • Published: Yes, Restrict Access: No- Article can be published for public viewing
  • ​​​​​​​​​​​​​​When it's added to a Related Article list, an article will appear on any Related Articles lists it's added to for all users who are able to sign in to TDX. 
    • Related Articles will not appear on the Technology Help website.

Troubleshoot: Related Article is Not Showing its Article Summary

If you are looking at an article's Related Articles section and do not see any text under an article's title, it means that article does not currently have an Article Summary set. 

To edit or to add an article summary:

1. In the Client Portal, open the Knowledge Base and navigate to the desired Article.
   • Or you can navigate directly to the Knowledge Base Search page and search for the article. 
2. Click Edit Article.
3. Click on the Settings tab.
4. In the Article Summary field, input an appropriate one-liner summary for the article. 
   • Refer to article TDX Knowledge: Create a New Knowledge Base Article for guidelines on entering an Article Summary. 
5. Click Save at the bottom of the page. 

Summary text will automatically update wherever the article is linked as a Related Article.