How to Read the Documentation

How to use the documentation, including a list of changes and new features

Welcome to the Humio Library!

The Humio documentation has been designed to offer a combination of different documentation types and styles to learn and use the product. These pages will help you to understand how to use and navigate the documentation:

Page Layout

Page Layout

Figure 1. Page Layout


A typical page within the documentation looks like Figure 1 and is divided into specific sections:

  • Top Bar:

    • On the left we have a logo which will always take you back to the Documentation Homepage

    • On the right is our interactive search box. This searches the whole documentation and enables you to click directly to the content. The search is context sensitive, it will show matches within the current documentation set (Core + Version). You can view a more detailed list of matching pages across all versions of the documentation by clicking the link. For guidance on searching and terms, see Documentation Search

  • Left Sidebar:

    • Table of Contents (TOC) for the site. This is split into:

      • Common areas of the documentation, such as Reference, Release Notes and Knowledge Base. These links are static and not expandable.

      • Dynamic Documentation TOC that you can use to navigate the entire documentation for the current version. You can click on the arrow next each item to expand and see all of the sub pages within that section. This section will always show the section and structure of the current page.

  • Main Panel:

    • Breadcrumbs at the top of the page enable you to identify and navigate through the structure that led to the current page of the documentation.

    • Main content of the page.

    • At the bottom of the page, you'll see the date the documentation was last updated, and a button to let us know how you found the documentation.

  • Right Sidebar

    • Page Contents is the table of contents specific to this page to help you navigate around the page and longer documents.

    • Related Information provides links to other pages in the documentation that might be useful or related to this page.

  • Availability and Version Information

    A section at the bottom of the right sidebar is used to display the areas of the product where the functionality is supported. The display will show one or more of:

    • Available

      A list of deployment environments, for example Humio Community Edition, Cloud EU, Self-Install, where the functionality displayed on this page is available.

    • Not Available

      A list of deployment environments where the functionality displayed on this page is specifically not supported or available.

    • Version Support

      An indication of the version information for the functionality shown on this page. The page will show:

      • Available Version — the specific version where this functionality was supported

      • Deprecated Version — the specific version where this functionality has been marked as deprecated

      • Removed Version — the specific version where this functionality was removed from the product and is no longer available

There are some exceptions to this content, such as the homepage, which does not have the sidebars, but all other pages follows this structure.

Documentation Structure

Our library is structured into two main sections:

  • Library Core — this area of the documentation is common and available throughout the library via the sidebar. The core content includes:

    • Questions — Frequently Asked Questions

    • Humio Training — Training, training videos and getting started guides for using Humio

    • Knowledge Base — Knowledge Base articles covering troubleshooting, best practices and How-To guides

    • Release Notes — Release notes

    • Humio Notices — Notices, security disclosures and third party licenses

Note that you can always switch between versions of the documentation, but the same page may not be available in all versions because it was a new (or deprecated) feature, or because it's specific to the on-prem or cloud products. For example, the Cloud documentation does not include a guide to installation because we provide you with a ready to use Humio cluster and you don't need to follow installation instructions.