第 3 章 使用 TechDocs


TechDocs 插件默认在 Red Hat Developer Hub 实例上安装并启用。在管理员配置 TechDocs 插件后,授权开发人员可使用 TechDocs 插件添加、查看或管理文档。

3.1. 在 TechDocs 中添加文档

在管理员配置 TechDocs 插件后,开发人员可以从远程存储库导入它来向 TechDocs 添加文档。任何授权用户或组都可以访问导入到 TechDocs 插件中的文档。

3.1.1. 从远程存储库将文档导入到 TechDocs

团队可以将其文档文件存储在存储其代码文件的同一个远程存储库中。您可以从包含团队使用的文档文件的远程存储库将文档导入到您的 TechDocs 插件中。

先决条件

  • 您的组织包含存储在远程存储库中的文档文件。
  • 在存储库的根目录中有一个 mkdocs.yaml 文件。
  • 您有 catalog.entity.createcatalog.location.create 权限,从远程存储库将文档导入到 TechDocs 中。

流程

  1. 在 Red Hat Developer Hub 实例中,点 Catalog > Self-service > Register Existing Component
  2. Select URL 框中,使用以下格式输入您要从存储库导入的 catalog-info.yaml 文件的 URL:

    https://github.com/&lt;project_name&gt; /<repo_name&gt; /blob/<branch_name&gt; /<file_directory> /catalog-info.yaml

  3. Analyze
  4. Finish

验证

  1. 在 Red Hat Developer Hub 导航菜单中,单击 Docs
  2. 验证您导入的文档是否在 Documentation 页面的表中列出。
返回顶部
Red Hat logoGithubredditYoutubeTwitter

学习

尝试、购买和销售

社区

关于红帽文档

通过我们的产品和服务,以及可以信赖的内容,帮助红帽用户创新并实现他们的目标。 了解我们当前的更新.

让开源更具包容性

红帽致力于替换我们的代码、文档和 Web 属性中存在问题的语言。欲了解更多详情,请参阅红帽博客.

關於紅帽

我们提供强化的解决方案,使企业能够更轻松地跨平台和环境(从核心数据中心到网络边缘)工作。

Theme

© 2025 Red Hat