Using the KB

Next

Welcome to Kentik’s swanky new knowledge base (KB)! The following sections explain the new format and navigation of the Kentik KB.

Page formats

The three page formats you’ll encounter are the KB’s landing page, an article view, and the advanced search.

Landing page

When you first navigate to kb.kentik.com or when you click the Home icon at the top left of an article view, the page you’ll see is our landing page. It is composed of the following elements: menu bar, search, categories, and article links.

Menu bar

A navigation bar at the top of the page displays the following elements:

  • Kentik logo: Links back to the knowledge base (KB) landing page when clicked on any page in the KB.

  • Kentik Portal: Opens the Kentik portal in a new tab.

  • What’s new (megaphone icon): Opens a list of the most recently published or updated articles in the KB, displayed in the Advanced search layout (most recent articles first).

  • Theme (sun/moon icon): Displays a popup menu to select a display theme for the KB: your system’s theme (default), Light, or Dark.

  • Login: Opens a page where Kentik employees can log in.

Search

When clicked, any search field in the KB opens a Search modal.  Articles that match your search criteria populate below the Search field as you type.

In this dialog, you can:

  • Clear your search criteria.

  • Display all search results, just articles, or just categories.

  • Click one of the listed articles or categories to view it.

  • Click Enter to activate our KB’s AI, which provides you with an AI-generated summary of what it thinks you’re looking for.

  • Click Go to advanced search to open the Advanced search page.

Categories

Three categories of articles are listed on the KB’s landing page. An article view for that category opens when you click one of the following:

  • Platform

  • Portal

  • Release Notes

Article links

Each of the following sections list the top five articles according to its criteria:

  • Recently Modified Articles

  • Recently Created Articles

  • Most Viewed Articles

Click any article to navigate directly to it.

Article view

When viewing an individual article, the screen is divided into four main parts: a header, the Explore articles sidebar (left), the article’s content, and the In this article sidebar (right).

Article header

At the top of each article view, the header displays the following elements:

  • Menu bar: A navigation bar at the top of the page that displays the Kentik logo, a link to the Kentik portal, What’s New, theme selection, and a login for Kentik employees (see Menu bar).

  • Breadcrumbs: Indicates where you are in the KB and allows you to click on topics or categories in the current article’s hierarchy and navigate directly to those pages.

    • The Home icon takes you to the KB’s landing page.

    • The Documentation portion of the breadcrumb will take you to the first article of the first category listed in the Explore articles sidebar.

  • Search: Opens a Search modal that allows you to search all articles within the KB.

As you scroll through the article, the Menu bar will disappear, and the following elements display in a condensed header: the breadcrumbs, the article’s name (with its copyable link) on the left side of the header, and Search, Share, and Print on the right. As you scroll farther, a bar at the top of the browser window travels from left to right to indicate how much of the article you’ve scrolled through.

Explore articles sidebar

The (collapsible) Explore articles sidebar, on the left side of an article view, displays all of the categories and topics of the knowledge base (KB). It features the following elements:

  • Filter (funnel icon): Opens a Filter field at the top of the sidebar where you can enter text to display only articles or categories that contain that text string. An article is displayed in its hierarchy of the topics and category.

  • Article hierarchy: Expand or collapse all categories and articles within the KB:

    • >: This category or article is currently collapsed and can be expanded to display more articles.

    • v: This category or article is expanded and can be collapsed.

  • Indicators: Indicators may appear to the right of an article or category. If the topic or category is collapsed, the indicator applies to a topic within its hierarchy.

    • Orange dot: Updated article.

    • Green dot: New article.

  • Violet text: Indicates that that article’s content is currently displayed on the page.

  • Category/article: Displays the category or article’s content when clicked, and:

    • Collapses if the article was expanded, or

    • Expands the article if it was collapsed.

  • More: Hover to the right of a topic or category to see the More kabob which allows you to follow the topic or category. A popup will appear where you can enter your email address to be notified when the article or category is updated.

    Note: If logged in, users with KB authoring permissions will not see the Follow button or the More button beside article names in the Explore articles sidebar.

Article display

The content of an article is displayed in the center of the screen. The following elements display within or above the article’s content:

  • Heading links: Hover over or beside any heading to display a link icon to its right. Click it to copy a link to the heading.

  • Publish dates: Indicate when the article was first published and the last time it was updated.

  • Time to read: An approximate time (in minutes) that it takes an average user to read that article.

  • Follow: Displays a popup where you can add your email address to be notified whenever that article is updated.

    Note: If logged in, users with KB authoring permissions will not see the Follow button or the More button beside article names in the Explore articles sidebar.

  • Edit article: For those who are logged in and have the appropriate authoring permissions, click this option to open the article in the authoring portal where you can update its contents.

  • Share: The Share button allows you to send a link to the article to an email recipient.

  • More: The More button to the right of the Share icon provides you with the option to open your system’s print settings and print the article.

  • Blue text: Indicates a link to another topic or article.

  • Orange text: Indicates an element of the portal’s UI (e.g., a button, table, or panel).

In this article sidebar

The (collapsible) In this article sidebar on the right side of an article shows all of the article’s topics in their hierarchical structure and is expanded by default. Click any topic to navigate to that part of the article. The sidebar features the following elements:

  • Topic hierarchy: Expand and collapse all topics and sub-topics within the KB:

    • : This topic is currently collapsed can be expanded to display more topics.

    • : This topic is expanded and can be collapsed.

  • Violet text: Indicates the topic(s) currently displayed on the page.

  • Vertical bar: Indicates the topic(s) currently displayed on the page.

  • Return to top: A button in the lower right corner of the sidebar will bring you back to the beginning of the article.

  • Topic header: Displays the topic content when clicked, and:

    • Collapses if the topic was expanded, or

    • Expands the topic if it was collapsed.

Advanced search

The advanced search view appears when you click the What’s New icon in the menu bar, or when you use the knowledge base’s (KB) advanced search (Search > Go to advanced search). The advanced search view includes:

  • Menu bar: A navigation bar at the top of the page that displays the Kentik logo, a link to the Kentik portal, What’s New, theme selection, and a login for Kentik employees (see Menu bar).

  • Breadcrumbs: Indicates where you are on the Search page and allows you to click either of the following pages to navigate directly to them:

    • The Home icon takes you to the KB’s landing page.

    • Documentation takes you to the first article of the first category listed in the Explore articles sidebar.

  • Back: Returns you to the page you were browsing before clicking to access the advanced search.

  • Search field: A field for you to enter your search term.

  • Filters: Criteria for you to further limit the search results.

  • Results: A list of articles and/or categories that match the search criteria.