4.3. Using TechDocs add-ons


After an administrator installs a TechDocs add-on in your Red Hat Developer Hub instance, you can use it to extend the functionality of the TechDocs plugin and enhance your documentation experience.

4.3.1. Using the ReportIssue TechDocs add-on

If you find an error in your organization’s TechDocs documentation, you can use the ReportIssue add-on to open a new GitHub or GitLab issue directly from the documentation. ReportIssue automatically imports the text that you highlight in the document into a new issue template in your repository.

Prerequisites

  • The ReportIssue add-on is installed and enabled in your TechDocs plugin.
  • You have permissions to create issues in the repository where documentation issues are reported.

Procedure

  1. In your TechDocs documentation, highlight the text that you want to report an issue for.
  2. Click the text in the ReportIssue box, for example, Open new GitHub issue.
  3. From the new issue page in your repository, use the template to create the issue that you want to report.

    참고

    The default issue title is Documentation feedback: <highlighted_text>, where <highlighted_text> is the text that you highlighted in your TechDocs documentation.

    In the issue description, <highlighted_text> is the default value for the The highlighted text field.

Verification

  • The issue that you created is listed on the issues page in your repository.

4.3.2. Using the TextSize TechDocs add-on

You can use the TextSize add-on to change the size of the text on either the TechDocs Reader page or an Entity page.

Prerequisites

  • The TextSize add-on is installed and enabled in your TechDocs plugin.

Procedure

  1. In your TechDocs header, click the Settings icon.
  2. Use the sliding scale to adjust the size of your documentation text.

    참고
    • The default text size is 100%
    • The minimize text size is 90%
    • The maximum text size is 150%

4.3.3. Using the LightBox TechDocs add-on

If your TechDocs documentation contains an image, you can use the LightBox add-on to view an enlarged version of the image in a lightbox, or overlay window. You can also zoom to change the size the lightbox image. If a single documentation page contains multiple images, you can navigate between images in the lightbox.

Prerequisites

  • The LightBox add-on is installed and enabled in your TechDocs plugin.

Procedure

  1. In your TechDocs documentation, click on the image that you want to view in a lightbox.
  2. In the lightbox, you can do any of the following actions:

    • Click the image or scroll to zoom in or zoom out.
    • Click the arrow to navigate between images.
Red Hat logoGithubredditYoutubeTwitter

자세한 정보

평가판, 구매 및 판매

커뮤니티

Red Hat 소개

Red Hat은 기업이 핵심 데이터 센터에서 네트워크 에지에 이르기까지 플랫폼과 환경 전반에서 더 쉽게 작업할 수 있도록 강화된 솔루션을 제공합니다.

보다 포괄적 수용을 위한 오픈 소스 용어 교체

Red Hat은 코드, 문서, 웹 속성에서 문제가 있는 언어를 교체하기 위해 최선을 다하고 있습니다. 자세한 내용은 다음을 참조하세요.Red Hat 블로그.

Red Hat 문서 정보

Legal Notice

Theme

© 2026 Red Hat
맨 위로 이동