InnerSourceCommons / InnerSourceCommons/InnerSourcePatterns

Japanese Patterns Book - Ideas for further improvement

Aperta
#430 0 commenti 1 reazione 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

Type - Translation
Lingua principale
HTML
Stelle
853
Fork
206
Merge medio
1g 23h
PR unite (30g)
2

Descrizione

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)

Guida per i contributori

Apri la guida per i contributori

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Direzione di ricerca

Scegli un elemento del lavoro futuro e inizia dai punti di ingresso indicati: .meta/pattern-template.md e lint-patterns.yml per la manutenzione, le cartelle translation/japanese e translations/jp per la struttura, oppure book/explore-patterns.md per i contenuti. Esamina i link alle issue correlate, quindi definisci il completamento come l'implementazione del miglioramento selezionato e la verifica dei link, dei contenuti o del workflow di pubblicazione interessati del libro giapponese.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Valutazione

Stack tecnologico
github-actions, markdown
Ambito
content, documentation, localization, release
Tipo di issue
Documentazione
Difficoltà
5/5
Tempo stimato
Più di una settimana
Stato di attività
Ferma
Chiarezza
Da chiarire
Idoneità per principianti
25/100

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.