3.3. Viewing documentation in TechDocs


In TechDocs, a document might be part of a book that contains other documents that are related to the same topic.

Clicking the name of a document in the table on the Documentation page opens the document in a book page. The name of the book is displayed on book the page. The book page contains the following elements:

  • The contents of the document.
  • A search bar that you can use to search for keywords within the document.
  • A navigation menu that you can use to navigate to other documents in the book.
  • A Table of contents that you can use to navigate to other sections of the document.
  • A Next button that you can use to navigate to the next sequential document in the book.

You can use the elements on the book page to search, view, and navigate the documentation in the book.

Prerequisites

  • The TechDocs plugin in enabled and configured
  • Documentation is imported into TechDocs
  • You have the required roles and permissions to add and view documentation to TechDocs
  • Optional: TechDocs add-ons are installed and configured

Procedure

  1. In the Red Hat Developer Hub navigation menu, click Docs.
  2. In the Documentation table, click the name of the document that you want to view.
  3. On the book page, you can do any of the following optional actions:

    • Use installed add-ons that extend the functionality of the default TechDocs plugin.
    • Use the search bar to find keywords within the document.
    • Use any of the following methods to navigate the documentation in the book:

      • Use the Table of contents to navigate the any section of the document.
      • Use the navigation menu to navigate to any document in the book.
      • Click Next to navigate to the next sequential document in the book.

Additional resources

Red Hat logoGithubredditYoutubeTwitter

学习

尝试、购买和销售

社区

關於紅帽

我们提供强化的解决方案,使企业能够更轻松地跨平台和环境(从核心数据中心到网络边缘)工作。

让开源更具包容性

红帽致力于替换我们的代码、文档和 Web 属性中存在问题的语言。欲了解更多详情,请参阅红帽博客.

关于红帽文档

Legal Notice

Theme

© 2026 Red Hat
返回顶部