InnerSourceCommons / InnerSourceCommons/InnerSourcePatterns
Japanese Patterns Book - Ideas for further improvement
Chưa có ai nhận issue này.
- Ngôn ngữ chính
- HTML
- Star
- 853
- Fork
- 206
- Merge trung bình
- 1 ngày 23 giờ
- Pull request đã merge (30 ngày)
- 2
Mô tả
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.ymlGHA 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/japanesetotranslation/jato make it consistent with the book URL as well as thebook/jafolder - see #452 - structure/maintenance - inside of
translations/jpkeep the same folder structure as inpatterns(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-jpbranch automatically when changes tomainare made. => I am opting to do this manually for now, as it does not require more than mergingmainintobook-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)
Hướng dẫn đóng góp
Bắt đầu từ đâu
- Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
- Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
- Fork repository và làm thay đổi trên một nhánh.
- Mở pull request có tham chiếu số hiệu của issue.
Hướng nghiên cứu
Chọn một mục công việc trong tương lai và bắt đầu với các điểm vào được tham chiếu: .meta/pattern-template.md và lint-patterns.yml cho việc bảo trì, các thư mục translation/japanese và translations/jp cho cấu trúc, hoặc book/explore-patterns.md cho nội dung. Xem lại các liên kết issue liên quan, sau đó xác định việc hoàn thành là khi cải tiến đã chọn được triển khai và các liên kết sách tiếng Nhật, nội dung hoặc quy trình xuất bản bị ảnh hưởng đã được xác minh.
Do mô hình lập chỉ mục viết ra từ nội dung của issue.
Đánh giá
- Công nghệ
- github-actions, markdown
- Lĩnh vực
- content, documentation, localization, release
- Loại issue
- Tài liệu
- Độ khó
- 5/5
- Thời gian dự kiến
- Hơn một tuần
- Mức độ hoạt động
- Đình trệ
- Độ rõ ràng
- Cần làm rõ
- Mức phù hợp với người mới
- 25/100