Create per-control article that links all KB articles related to the control

[pepinho24]

Is your feature request related to a problem? Please describe.

Currently, the only way to search for a KB is either go through the paged list in the KB home page (e.g. https://docs.telerik.com/devtools/aspnet-ajax/knowledge-base/). There is no way to see all KBs related to a specific control unless you use the control as a keyword in the search

Describe the solution you'd like

Ideally, each control folder would have an article where all related KB articles will be listed.

Describe alternatives you've considered

Here are some previously discussed ideas about the best way to automatically link the KB articles to the respective components:

• Add a separate .md file for each component - This would allow great flexibility like adding additional content, and determine the name of the article per product suite
  • The name of the article is to be discussed. Generally, we agreed that More examples would be a suitable name.
• Set the published flag to false. When the plugin which automatically generates the articles finds a related KB it will automatically set it to true.
  -Add an additional tag to each KB article like related_components and list all applicable components/controls there.
• In order to list the KB articles to a specific location add a template like {% include ....... %}.
• The list of KB articles will look a lot like they currently show when being searched through the docs.

Key benefits

• SEO improvements
• More recognition for the KB articles
• More business scenarios covered in the documentation - KBs are generally business scenarios taken from tickets.
• Hopefully, reduced ticket load
• A quick way for us as support people to find KB articles

Some questions to think of

• In which folder shall we place the KB articles that cover a common scenario that is not related to a specific component
• Additional flag in the header (front-matter) of the dedicated article which tells the plugin for which component it is. For example target_component: grid.

This feature was separately requested by the Ajax, Blazor and some of the Desktop teams so it should benefit most if not all docs-seed based suites.

Please follow-up with some additional requirements/ideas/concerns with creating such articles for each controls.

cc: @marin-bratanov @svdimitr @Jekata @DinkoK

[marin-bratanov]

This is something we've discussed a few times, and such things have been done manually over the years, always with the effect that these lists easily get stale. Thus, an automatic feature would be nice.

I think it should be hidden behind some class in the docs-seed backend so you can plug it into any page you desire - just add something like {%relatedKb component=grid %} to your .md file and docs-seed will extract the relevant kbs with the corresponding related_component from the list and render their links (with titles, and maybe the seo title in addition, if present and different than the html title).

This will let each team decide where and how and when to use (or not use) this feature, they can enable it on demand, and plug it in any page they want to (say, even the overview of the component), and and an name their articles as they see fit.