openEuler 官方文档检视测试流程

概述

背景:openEuler 官方文档从24.03 LTS SP2版本起,文档已下沉至各sig组。
下沉前:所有发布在官网的文档都在openeuler/docs仓存储,由doc-sig负责合入。
下沉后:
基础特性文档(发行说明、安装指南)还放在docs仓,由doc-sig负责合入。
增量特性文档:oeaware用户指南、syscare用户指南,放在特性对应的代码仓,由sig maintainer负责合入。
问题:文档下沉至sig组代码仓后,文档pr检视合入由sig maintainer决定,doc-sig检视/测试验收是非必须的,由sig maintainer决定并邀请,存在文档检视、测试不充分,导致文档质量无法得到保证。

检视测试流程

image

版本发布之前

  1. 版本关键角色,根据版本需求,确定文档清单和交付计划,文档工程师跟踪版本文档需求交付进展;
  2. openeuler/docs 仓拉取新分支;
  3. 代码仓拉取新分支;
  4. 特性 owner 贡献文档,提 PR;
  5. 特性 sig maintainer 检视文档;
  6. 文档工程师检视文档,转测试;
  7. 测试工程师检视文档;
  8. 特性 owner 修改 pr 意见;
  9. 特性 sig maintainer 合入文档。

版本发布之后

  1. 用户使用文档之后,发现文档问题;
  2. 提交文档issue(基础特性文档提到 docs 仓,增量特性文档提到各个 sig 组代码仓;如果提到 docs 仓,则由 doc sig maintainer 转到对应代码仓);
  3. 特性 owner 处理 issue,提交文档 PR;
  4. sig maintainer 检视文档;
  5. 文档工程师检视文档,如仅低错修改,无需转测试;如涉及实际内容修改,则转测试(每周或双周固定时间转测试,与update版本issue转测节奏保持一致);
  6. 测试工程师检视文档;
  7. 特性 owner 修改 pr 意见;
  8. sig maintainer 合入文档。