slidevjs / docs-cn

Chinese documentation for sli.dev
https://cn.sli.dev
58 stars 47 forks source link

有关当前 docs-cn 如何保证和上游内容的强一致的疑问 #229

Open normal-coder opened 3 months ago

normal-coder commented 3 months ago

如同 #228 中内容。参与翻译过程中的小问题:当前仓库中文档内容尚未和 https://github.com/slidev/slidev 保持强一致更新(由于部分内容已经被翻译,没法做到全量更新),在这种情况下:

  1. 当前团队是否有定期从英文文档更新内容到翻译仓库?
  2. 如何避免外部 contributor 还在翻译调整旧的内容?

貌似这些问题还没有一个机制去维护或告知。欢迎交流。

KermanX commented 3 months ago
  1. 当前团队是否有定期从英文文档更新内容到翻译仓库?

其实docs-cn在几个月前的很长时间一直基本没有同步,几个月前我把严重过时内容用英文替换了,然后@xiaodong2008陆续将这些英文内容完成了翻译,构成了现在的中文版翻译。

  1. 如何避免外部 contributor 还在翻译调整旧的内容?

在 PR 的 template 里有一些提示,但是似乎不够明显(而且写完内容提PR的时候才会看到)。不知道是否有更加明显的提示方式?


目前计划是在sync分支逐步翻译完新版文档后,一次性合并到主分支,以避免不一致。main分支的旧内容也接收修复PR。目前进度比计划略慢,主要原因是我最近没有投入很多时间+小东比较忙。

如果方便的话也可以考虑加一下 QQ群 978643067,当然通过 GitHub 讨论也完全没问题😇

normal-coder commented 3 months ago
  1. 当前团队是否有定期从英文文档更新内容到翻译仓库?

其实docs-cn在几个月前的很长时间一直基本没有同步,几个月前我把严重过时内容用英文替换了,然后@xiaodong2008陆续将这些英文内容完成了翻译,构成了现在的中文版翻译。

  1. 如何避免外部 contributor 还在翻译调整旧的内容?

在 PR 的 template 里有一些提示,但是似乎不够明显(而且写完内容提PR的时候才会看到)。不知道是否有更加明显的提示方式?

目前计划是在sync分支逐步翻译完新版文档后,一次性合并到主分支,以避免不一致。main分支的旧内容也接收修复PR。目前进度比计划略慢,主要原因是我最近没有投入很多时间+小东比较忙。

如果方便的话也可以考虑加一下 QQ群 978643067,当然通过 GitHub 讨论也完全没问题😇

大概有几个经验或许可以帮上忙:

  1. 维护文档的时候,通过 Action 做定期做同步的 Pull Request,此部分 Pull Request 可以在完成翻译后放入(其实就是你现在做的这种方式)
  2. 小细节的更新,适当的直接更新文档上游,把未翻译部分直接在文档放出(虽然要考虑大部分受众的感受,但同样也缺乏贡献者,不完美的部分可以吸引到来自社区的用户参与,这也是一种运营项目的方式)
  3. 大量来自 maintainer 和 contributor 的翻译经验可以考虑沉淀下来,目前看官网是有一些指导,但对细节部分多数会出现在 Pull Request 审核过程,的确是沉淀需要心思
    1. 对切换语言体验存在破坏性操作的(如锚点变更)
    2. 要求翻译时需要保证一定的完整度才能完成 Pull Request(如翻译标题一定要保证锚点完整性)
    3. 如增加内容,需要和英文文档保持一致,或说明具体的缘由等等...