3.3. TechDocs アドオンの使用


管理者が Red Hat Developer Hub インスタンスに TechDocs アドオンをインストールしたら、それを使用して TechDocs プラグインの機能を拡張し、ドキュメントエクスペリエンスを強化できます。

3.3.1. ReportIssue TechDocs アドオンの使用

組織の TechDocs ドキュメントにエラーが見つかった場合は、ReportIssue アドオンを使用して、ドキュメントから直接新しい GitHub または GitLab のイシューを作成できます。ReportIssue により、ドキュメント内で強調表示したテキストが、リポジトリー内の新しいイシューテンプレートに自動的にインポートされます。

前提条件

  • ReportIssue アドオンが TechDocs プラグインにインストールされ、有効になっている。
  • ドキュメントの問題の報告先リポジトリーでイシューを作成する権限がある。

手順

  1. TechDocs ドキュメントで、イシューとして報告するテキストを強調表示します。
  2. ReportIssue ボックス内のテキスト (例: Open new GitHub issue) をクリックします。
  3. リポジトリーの新しいイシューページから、報告するイシューをテンプレートを使用して作成します。

    注記

    デフォルトのイシュータイトルは Documentation feedback: <highlighted_text> です。<highlighted_text> は、TechDocs ドキュメントで強調表示したテキストです。

    イシューの説明では、<highlighted_text>The highlighted text フィールドのデフォルト値になります。

検証

  • 作成したイシューがリポジトリーのイシューページにリスト表示されます。

3.3.2. TextSize TechDocs アドオンの使用

TextSize アドオンを使用すると、TechDocs Reader ページまたは Entity ページのテキストのサイズを変更できます。

前提条件

  • TextSize アドオンが TechDocs プラグインにインストールされ、有効になっている。

手順

  1. TechDocs ヘッダーで、Settings アイコンをクリックします。
  2. スライドスケールを使用して、ドキュメントのテキストのサイズを調整します。

    注記
    • デフォルトのテキストサイズは 100% です。
    • 最小テキストサイズは 90% です。
    • 最大テキストサイズは 150% です。

3.3.3. LightBox TechDocs アドオンの使用

TechDocs ドキュメントに画像が含まれている場合は、LightBox アドオンを使用して、ライトボックスまたはオーバーレイウィンドウで拡大版の画像を表示できます。ズームしてライトボックスの画像のサイズを変更することもできます。1 つのドキュメントページに複数の画像が含まれている場合は、ライトボックスで画像を切り替えることができます。

前提条件

  • LightBox アドオンが TechDocs プラグインにインストールされ、有効になっている。

手順

  1. TechDocs ドキュメントで、ライトボックスで表示する画像をクリックします。
  2. ライトボックスでは、次のいずれかの操作を実行できます。

    • 画像をクリックするかスクロールして拡大または縮小します。
    • 矢印をクリックして画像を切り替えます。
Red Hat logoGithubredditYoutubeTwitter

詳細情報

試用、購入および販売

コミュニティー

Red Hat ドキュメントについて

Red Hat をお使いのお客様が、信頼できるコンテンツが含まれている製品やサービスを活用することで、イノベーションを行い、目標を達成できるようにします。 最新の更新を見る.

多様性を受け入れるオープンソースの強化

Red Hat では、コード、ドキュメント、Web プロパティーにおける配慮に欠ける用語の置き換えに取り組んでいます。このような変更は、段階的に実施される予定です。詳細情報: Red Hat ブログ.

会社概要

Red Hat は、企業がコアとなるデータセンターからネットワークエッジに至るまで、各種プラットフォームや環境全体で作業を簡素化できるように、強化されたソリューションを提供しています。

Theme

© 2026 Red Hat
トップに戻る