介绍
更新时间:2025/5/16
在Gitcode上查看源码

本文介绍 openUBMC 文档的生产发布流程与文档仓的组织架构,同时提供每本手册在文档仓中的具体存放位置。

  • 文档中心将社区文档按社区使用指南、开发者指南和测试指南模块进行划分:
    • 社区使用指南:社区体验地图、贡献指南、版本说明。
    • 开发者指南:快速入门、开发指南、参考指南、工具指南、API文档、术语表。
    • 测试指南:快速入门、开发与技术常见问题。
  • 发布机制:
    • 每个场景及工具模块均有对应目录结构文件(_menu.json)。这些配置文件均存于 openUBMC/docs 仓,由 DOC SIG 集中管理。
    • 各文档的责任 SIG 需将文档目录结构文件引用,添加到所属场景或工具模块的目录结构文件中,使文档可在对应模块下呈现。
  • 文档生产:
    • openUBMC的文档生产在 openUBMC/docs 仓以及各 SIG 组的 docs 仓中进行。
    • 各 SIG 在文档仓中维护的文件包括:文档内容文件和目录结构文件(_menu.json)。其中,文档内容文件用来存放文档实际内容,文档目录结构文件用来维护文档章节呈现结构。

在文档仓中,docs 目录下的内容会展示于官网,其下设有 zh 和 en 两个子目录,分别用以存放中文文档与英文文档,文档目录结构严格参照官网呈现的目录层级规划设置。此外,文档仓还设有 archive 目录,用来存放暂不适合推广,或尚不成熟的文档。待文档完善且满足发布需求时,再将其移至 docs 目录,以便在官网展示。

text
├─docs          <!-- 在文档中心发布的文档 -->
│  ├─public     <!-- 公共文档,包含:目录结构文件(_menu.json) -->
│  ├─en         <!-- 英文文档 -->
│  └─zh         <!-- 中文文档 -->
├─archive  <!-- 不在文档中心发布的文档 -->