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 摘要。