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 Copy linkLink copied!
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 Copy linkLink copied!
- The
ReportIssueadd-on is installed and enabled in your TechDocs plugin. - You have permissions to create issues in the repository where documentation issues are reported.
Procedure Copy linkLink copied!
Results Copy linkLink copied!
- The issue that you created is listed on the issues page in your repository.
Configure documentation text scaling Copy linkLink copied!
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 Copy linkLink copied!
- The
TextSizeadd-on is installed and enabled in your TechDocs plugin.
Procedure Copy linkLink copied!
Configure image overlay features Copy linkLink copied!
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 Copy linkLink copied!
- The
LightBoxadd-on is installed and enabled in your TechDocs plugin.
Procedure Copy linkLink copied!
- In your TechDocs documentation, click the image that you want to view in a lightbox.
- 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.