第1章 TechDocs について
Red Hat Developer Hub インスタンスには、デフォルトで TechDocs プラグインがインストールされ、有効になっています。組織では、TechDocs プラグインを使用して、一元的な場所で、標準化された方法でドキュメントを作成、検索、管理できます。また、組み込みの TechDocs 機能やアドオンを使用して、技術ドキュメントのエクスペリエンスを強化することもできます。以下に例を示します。
- docs-like-code アプローチ
- 技術ドキュメントを Markdown ファイルに記述し、コードとともにプロジェクトリポジトリー内に保存します。
- ドキュメントサイトの生成
- MkDocs を使用して、Developer Hub で一元的にレンダリングされるドキュメント用に、フル機能の Markdown ベースの静的 HTML サイトを作成します。
- ドキュメントサイトのメタデータと統合
- 静的ドキュメントに加えて、最終更新日、サイト所有者、トップコントリビューター、未解決の GitHub イシュー、Slack サポートチャネル、Stack Overflow Enterprise タグなど、ドキュメントサイトに関する追加のメタデータを参照できます。
- 組み込みのナビゲーションおよび検索機能
- ドキュメント内で必要な情報を迅速かつ簡単に見つけます。
- アドオン
- サポートされている TechDocs アドオンを使用して、ドキュメントをより機能的かつインタラクティブなものにします。一部のアドオンはプリインストールされており、デフォルトで有効になっています。デフォルトの機能を拡張するには、外部およびサードパーティーのアドオンを Red Hat Developer Hub インスタンスに動的にロードできます。TechDocs のエクスペリエンスをさらにカスタマイズする場合は、組織固有のドキュメントニーズに合わせてアドオンを作成できます。