Use enabled 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.

Configure documentation issue reporting

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.

Before you begin

  • 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.
    Note

    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.

Results

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

Configure documentation text scaling

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

Before you begin

  • 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.
    Note
    1. The default text size is 100%
    2. The minimize text size is 90%
    3. The maximum text size is 150%

Configure image overlay features

Use the LightBox add-on to view enlarged images in a lightbox overlay window and navigate between images on a single documentation page.

Before you begin

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

Procedure

  1. In your TechDocs documentation, click the image that you want to view in a lightbox.
  2. In the lightbox, you can do any of the following actions:
  3. Click the image or scroll to zoom in or zoom out.
  4. Click the arrow to navigate between images.