3.3. TechDocs アドオンの使用
管理者が Red Hat Developer Hub インスタンスに TechDocs アドオンをインストールしたら、それを使用して TechDocs プラグインの機能を拡張し、ドキュメントエクスペリエンスを強化できます。
3.3.1. ReportIssue TechDocs アドオンの使用 リンクのコピーリンクがクリップボードにコピーされました!
組織の TechDocs ドキュメントにエラーが見つかった場合は、ReportIssue アドオンを使用して、ドキュメントから直接新しい GitHub または GitLab のイシューを作成できます。ReportIssue により、ドキュメント内で強調表示したテキストが、リポジトリー内の新しいイシューテンプレートに自動的にインポートされます。
前提条件
-
ReportIssueアドオンが TechDocs プラグインにインストールされ、有効になっている。 - ドキュメントの問題の報告先リポジトリーでイシューを作成する権限がある。
手順
- TechDocs ドキュメントで、イシューとして報告するテキストを強調表示します。
-
ReportIssueボックス内のテキスト (例: Open new GitHub issue) をクリックします。 リポジトリーの新しいイシューページから、報告するイシューをテンプレートを使用して作成します。
注記デフォルトのイシュータイトルは Documentation feedback: <highlighted_text> です。<highlighted_text> は、TechDocs ドキュメントで強調表示したテキストです。
イシューの説明では、<highlighted_text> が The highlighted text フィールドのデフォルト値になります。
検証
- 作成したイシューがリポジトリーのイシューページにリスト表示されます。
3.3.2. TextSize TechDocs アドオンの使用 リンクのコピーリンクがクリップボードにコピーされました!
TextSize アドオンを使用すると、TechDocs Reader ページまたは Entity ページのテキストのサイズを変更できます。
前提条件
-
TextSizeアドオンが TechDocs プラグインにインストールされ、有効になっている。
手順
- TechDocs ヘッダーで、Settings アイコンをクリックします。
スライドスケールを使用して、ドキュメントのテキストのサイズを調整します。
注記- デフォルトのテキストサイズは 100% です。
- 最小テキストサイズは 90% です。
- 最大テキストサイズは 150% です。
3.3.3. LightBox TechDocs アドオンの使用 リンクのコピーリンクがクリップボードにコピーされました!
TechDocs ドキュメントに画像が含まれている場合は、LightBox アドオンを使用して、ライトボックスまたはオーバーレイウィンドウで拡大版の画像を表示できます。ズームしてライトボックスの画像のサイズを変更することもできます。1 つのドキュメントページに複数の画像が含まれている場合は、ライトボックスで画像を切り替えることができます。
前提条件
-
LightBoxアドオンが TechDocs プラグインにインストールされ、有効になっている。
手順
- TechDocs ドキュメントで、ライトボックスで表示する画像をクリックします。
ライトボックスでは、次のいずれかの操作を実行できます。
- 画像をクリックするかスクロールして拡大または縮小します。
- 矢印をクリックして画像を切り替えます。