InnerSourceCommons / InnerSourceCommons/InnerSourcePatterns
Japanese Patterns Book - Ideas for further improvement
Dieses Issue hat noch niemand übernommen.
- Vorherrschende Sprache
- HTML
- Sterne
- 853
- Forks
- 206
- Ø Merge
- 1 T. 23 Std.
- Gemergte PRs (30 T.)
- 2
Beschreibung
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)
Beitragsleitfaden
Erste Schritte
- Lies das ganze Issue und danach den Beitragsleitfaden des Projekts.
- Schreib ins Issue, dass du es übernimmst — das erspart doppelte Arbeit.
- Forke das Repository und arbeite in einem Branch.
- Öffne einen Pull Request, der die Issue-Nummer nennt.
Rechercherichtung
Wähle einen Eintrag aus den zukünftigen Arbeiten und beginne mit den referenzierten Einstiegspunkten: .meta/pattern-template.md und lint-patterns.yml für Wartung, die Ordner translation/japanese und translations/jp für die Struktur oder book/explore-patterns.md für Inhalte. Prüfe die Links zu den zugehörigen Issues und definiere den Abschluss so, dass die ausgewählte Verbesserung implementiert und die betroffenen Links, Inhalte oder der Veröffentlichungsworkflow des japanischen Buchs überprüft wurden.
Vom Indexierungsmodell aus dem Issue-Text verfasst.
Bewertung
- Tech-Stack
- github-actions, markdown
- Bereich
- content, documentation, localization, release
- Issue-Typ
- Dokumentation
- Schwierigkeit
- 5/5
- Geschätzter Aufwand
- Über eine Woche
- Aktivitätsstatus
- Veraltet
- Klarheit
- Muss geklärt werden
- Anfängerfreundlichkeit
- 25/100