srs.wiki与zh-cn/en-us文档同步
panda1986 opened this issue · comments
panda commented
-
如何讲srs.wiki目录下各个版本的md文件分散到srs-docs不同版本的中英文目录下
- 比如git clone https://github.com/ossrs/srs.wiki.git后,
- 将v4_EN_Edge.md对应存放到versioned_docs/version-4.0/doc/目录下
- 将v4_CN_Edge.md对应存放到i18n/zh-cn/docusaurus-plugin-content-docs/version-4.0/doc/目录下
- 假如以后补充了5.0的wiki, 需要将
- 将v5_EN_Edge.md对应存放到i18n/en-us/docusaurus-plugin-content-docs/current/doc/目录下
- 将v5_CN_Edge.md对应存放到i18n/zh-cn/docusaurus-plugin-content-docs/current/doc/目录下
- srs.wiki需保证每一个文件,对应的中英文文件都存在
- 比如git clone https://github.com/ossrs/srs.wiki.git后,
-
当srs.wiki更新后,如何将对应文件的修改同步到srs-docs对应的文件
- 在srs.wiki更新后,可能需要在srs-docs记录之前同步的commit信息,并与srs.wiki进行diff检查
- 修改文件,则将修改后的文件直接同步到对应目录
- 增加文件,则需要将文件拷贝到对应目录,并修改sidebar.js, 以及write-translations
- 删除文件,则需要将对应文件从doc目录中删除,并修改sidebar.js, 以及write-translations
- 在srs.wiki更新后,可能需要在srs-docs记录之前同步的commit信息,并与srs.wiki进行diff检查
xiaosong commented
需要注意的点:
- wiki 中文件名拷贝过来后有两处不一样,v4_EN_ 前缀需要删除,wiki 中大小写改成使用 - 连接(文件名转换可以通过 sidebar.json 的内容进行转换)
- srs-docs 新增的头部内容是否同步到 wiki 中
- 可以根据 sidebar.json 的内容检查出文档的新增和删除
- 文件的目录结构也可以通过 sidebar.json 的内容解析出来,这样不用在多个文件中进行同步
- 可能有些文件是 srs-docs 中有,但是 wiki 中没有
- 最好能基于文件内容的比较,wiki 的 commit 太多了,比较起来应该比较难
- 内容中链接的问题,wiki 中直接使用的相对路径,如果 srs-docs 中的目录结构和 wiki 不一样,这个也需要能够自动替换过去(目前想到的方案是在拷贝文件的时候将目录结构的对应关系缓存起来,然后遍历文件进行替换)
Winlin commented
等我们这次迁移到新的官网后,之前github的wiki,会直接链接到新官网的文档,这样我们就不用同步了。