第 3 章 使用 TechDocs
TechDocs 插件默认在 Red Hat Developer Hub 实例上安装并启用。在管理员配置 TechDocs 插件后,授权开发人员可使用 TechDocs 插件添加、查看或管理文档。
3.1. 在 TechDocs 中添加文档 复制链接链接已复制到粘贴板!
复制链接链接已复制到粘贴板!
在管理员配置 TechDocs 插件后,开发人员可以从远程存储库导入它来向 TechDocs 添加文档。任何授权用户或组都可以访问导入到 TechDocs 插件中的文档。
3.1.1. 从远程存储库将文档导入到 TechDocs 复制链接链接已复制到粘贴板!
复制链接链接已复制到粘贴板!
团队可以将其文档文件存储在存储其代码文件的同一个远程存储库中。您可以从包含团队使用的文档文件的远程存储库将文档导入到您的 TechDocs 插件中。
先决条件
- 您的组织包含存储在远程存储库中的文档文件。
-
在存储库的根目录中有一个
mkdocs.yaml文件。 -
您有
catalog.entity.create和catalog.location.create权限,从远程存储库将文档导入到 TechDocs 中。
流程
- 在 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
验证
- 在 Red Hat Developer Hub 导航菜单中,单击 Docs。
- 验证您导入的文档是否在 Documentation 页面的表中列出。