第3章 TechDocs の使用

TechDocs プラグインが Red Hat Developer Hub インスタンスにデフォルトでインストールされ、有効化されています。管理者が TechDocs プラグインを設定した後、認可された開発者は TechDocs プラグインを使用してドキュメントを追加、表示、または管理できます。

3.1. TechDocs へのドキュメントの追加
リンクのコピー

管理者が TechDocs プラグインを設定した後、開発者はリモートリポジトリーからドキュメントをインポートすることで TechDocs にドキュメントを追加できます。認可されたユーザーまたはグループは誰でも、TechDocs プラグインにインポートされたドキュメントにアクセスできます。

チームは、コードファイルを保存しているのと同じリモートリポジトリーに、ドキュメントファイルを保存できます。チームが使用するドキュメントファイルが含まれるリモートリポジトリーから、TechDocs プラグインにドキュメントをインポートできます。

前提条件

組織には、リモートリポジトリーに保存されているドキュメントファイルがある。
リポジトリーの root ディレクトリーに mkdocs.yaml ファイルがある。
ドキュメントをリモートリポジトリーから TechDocs にインポートするための catalog.entity.create および catalog.location.create パーミッションがある。

手順

Red Hat Developer Hub インスタンスで、Catalog > Self-service > Register Existing Component の順にクリックします。
Select URL ボックスに、次の形式を使用して、リポジトリーからインポートする catalog-info.yaml ファイルの URL を入力します。
https://github.com/<project_name>/<repo_name>/blob/<branch_name>/<file_directory>/catalog-info.yaml
Analyze をクリックします。
Finish をクリックします。

検証