InnerSourceCommons / InnerSourceCommons/InnerSourcePatterns

Japanese Patterns Book - Ideas for further improvement

未关闭
#430 0 条评论 1 个 reaction 已指派 0 人 在 GitHub 查看

还没有人认领这个 Issue。

Type - Translation
主要语言
HTML
星标
853
派生
206
平均合并
1 天 23 小时
30 天内合并 PR
2

描述

As part fo #422 we identified some things that are not essential for the first release of the Japanese Patterns Book.
Still they could be considered to improve the book further.

These ideas are listed below, and after the first book release we can decide how to prioritize these.

Future Work for the Japanese Patterns Book

  • maintenance - The lint-patterns.yml GHA checks that all patterns contain the mandatory headlines as defined in .meta/pattern-template.md. This isn't essential for JP patterns, as those are translations of EN patterns anyways, for which we have confirmed that they have these mandatory headlines. We can try to adapt this GHA to also check the required headlines in JP patterns but it isn't essential
  • ✅ structure/maintenance - I am suggesting to rename the folder translation/japanese to translation/ja to make it consistent with the book URL as well as the book/ja folder - see #452
  • structure/maintenance - inside of translations/jp keep the same folder structure as in patterns (that way all links to other patterns and assets will stay the same). => As this would require to check all links in the JP patterns again I am pushing this to Future Work
  • gitbook publishing - update book-jp branch automatically when changes to main are made. => I am opting to do this manually for now, as it does not require more than merging main into book-jp. In the future we can automate this, maybe with this action to create a PR and this one to auto-merge. or better to merge without a PR?
  • content - what to do with the mindmap? book/explore-patterns.md - We decided to keep it in English for the 1st release
  • content - the captions of most images are still in English e.g. see this
  • ✅ content - translate the book cover itself to Japanese too? (I do have the source files, so if somebody helps me with the translations then we can do this)

贡献指南

打开贡献指南

从这里开始

  1. 先读完整个 Issue,再读项目的贡献指南。
  2. 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
  3. Fork 仓库,在一个分支上完成修改。
  4. 提交 Pull Request,并在描述里引用这个 Issue 编号。

调研方向

选择一个未来工作项,并从所引用的入口开始:维护使用 .meta/pattern-template.md 和 lint-patterns.yml,结构使用 translation/japanese 和 translations/jp 文件夹,内容使用 book/explore-patterns.md。查看相关 issue 链接,然后将完成定义为:所选改进已实现,并且受影响的日文书籍链接、内容或发布工作流已验证。

由索引模型根据 Issue 内容生成。

评估

技术栈
github-actions, markdown
领域
content, documentation, localization, release
Issue 类型
文档
难度
5/5
预计耗时
一周以上
活跃度
停滞
描述清晰度
需要澄清
新手友好度
25/100

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。