Skip to content

Maintenance

alanxtl edited this page Sep 20, 2026 · 1 revision

文档维护

首页 · 来源与范围 · 历史档案

页面分工

  • 根目录保留 Home.md、_Sidebar.md、_Footer.md;专题指南位于 guides/,维护资料位于 maintenance/。
  • website/、repository/、discussions/、releases/、archive/ 中的来源阅读页与目录由 tools/build_wiki.py 生成;需要改正原文时优先修改上游,或者在专题页注明差异。
  • sources/ 保存不可执行的原始资料与清单。Markdown 快照使用 .md.txt 扩展名,避免 GitHub Wiki 把多个 README/_index 识别成同名页面。
  • 历史 Wiki 的原始文件另外存入 ZIP;阅读页增加历史标识、调整链接,原始字节仍可核验。

文件夹结构

dubbo-go.wiki/
├── Home.md / _Sidebar.md / _Footer.md
├── guides/                 入门、架构、配置、治理、工具、排障、升级与社区
├── website/
│   ├── sdk/                Go SDK 手册
│   ├── historical/         旧版官网教程
│   ├── articles/           技术文章与发布介绍
│   └── related/            其他关联资料
├── repository/             主仓库文档
│   └── tools/              工具 README
├── discussions/            讨论、评论与回复
├── releases/
│   ├── framework/          框架正式发布
│   ├── prereleases/        预发布
│   └── tools/              独立工具发布
├── archive/                旧 Wiki 阅读页
├── assets/archive/         旧 Wiki 图片和 PPT
├── maintenance/            来源、维护方法与校验报告
├── sources/                原始快照、数据、清单与完整旧 Wiki ZIP
└── tools/                  采集、生成、目录布局与校验脚本

文件夹用于管理源码,页面文件名保持全局唯一。Wiki 内链统一使用完整页面 URL,保留原页面名;目录布局由 tools/wiki_layout.py 管理。链接格式依据 GitHub Wiki 编辑文档。

离线重建与检查

需要 Python 3.10 或更新版本。以下命令在 Wiki 仓库根目录执行,不需要访问网络,也不会改 Git 暂存区:

python tools/build_wiki.py
python tools/validate_wiki.py

校验内容包括来源哈希、旧 Wiki ZIP 全量字节、收录数量、Discussion 评论/回复、页面名唯一性、Wiki 内部链接与首页可达性。查看校验报告。外部站点链接以及所有历史代码示例不在“全部验证通过”的范围内。原文中保留的 Hugo 特性会单独列入报告,不伪装成已经修好;作者本地磁盘链接转换为文字路径,原始内容完整保存。

更新远端资料

首次采集使用相邻目录 dubbo-go、dubbo-website 和旧 Wiki 的 Git 对象。重新抓取之前,先提交或另行保存当前工作,然后审查要使用的源提交。采集命令需要 gh 的 GitHub 读取权限。

git -C ../dubbo-website fetch https://github.com/apache/dubbo-website.git master
python tools/collect_sources.py
python tools/build_wiki.py
python tools/validate_wiki.py

采集脚本使用主仓库 HEAD、官网 FETCH_HEAD、固定的旧 Wiki 基线提交;它不会替你更新主仓库、切换分支或清理工作区。因此更新前必须确认这些提交是希望收录的版本。每次重新采集会覆盖源数据快照;审查 diff 并提交 Git 历史,保留前次快照。它抓取全部公开 Discussions 和公开非草稿 Releases,逐页读取评论和回复。

新增、移除源文件或远端讨论后,需要审核旧生成页面的去留;构建脚本不自动删除已有页面。确认上游删除不是误操作后,可将已撤下页面转入历史档案。专题页、首页日期、版本表与重点讨论列表需要维护者复核,不靠重新抓取自动判定技术结论。

收录与编辑规则

每个实质结论附来源,并标明是正式发布、源码约定、设计提案、已采纳问答还是历史记录。不要用 Discussion 的关闭状态推断问题已经解决;不要把旧文的“最新稳定版”搬到首页;不要把一个工具的 tag 当成框架版本。

同一内容的中英文、官网与仓库版本分别保留,避免无依据地认定二者完全等价。修订链接只改变阅读页,原始快照保持字节一致。外部资产保留原链接,本次只对旧 Wiki 自带图片和 PPT 做完整附件归档。

发布方式

这是 GitHub Wiki 仓库。页面按类型存放,同时保留原页面名和导航 URL。先查看 Home、侧栏、专题页和校验报告,再用通常的 Git 提交/推送流程发布。推送到 Wiki 默认分支会直接更新公开 Wiki;本轮重建交付在本地工作区,尚未推送。

旧 Wiki 中 How-to-release-a-new-version?.md 含 Windows 不支持的问号,阅读页改为 How-to-release-a-new-version.md;ZIP 内保存原始名称。Windows 上无法保留这一原路径的可检出文件,其余旧常规页面入口继续保留。

Clone this wiki locally