InnerSourceCommons / InnerSourceCommons/InnerSourcePatterns
Japanese Patterns Book - Ideas for further improvement
Nadie ha tomado este issue todavía.
- Lenguaje dominante
- HTML
- Estrellas
- 853
- Forks
- 206
- Merge medio
- 1 d 23 h
- PR fusionados (30 d)
- 2
Descripción
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)
Guía de contribución
Primeros pasos
- Lee el issue completo y luego la guía de contribución del proyecto.
- Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
- Haz un fork del repositorio y trabaja en una rama.
- Abre un pull request que haga referencia al número del issue.
Línea de trabajo
Elige un elemento de trabajo futuro y comienza con los puntos de entrada referenciados: .meta/pattern-template.md y lint-patterns.yml para el mantenimiento, las carpetas translation/japanese y translations/jp para la estructura, o book/explore-patterns.md para el contenido. Revisa los enlaces a los issues relacionados y define la finalización como la implementación de la mejora seleccionada y la verificación de los enlaces, el contenido o el flujo de publicación afectados del libro japonés.
Escrito por el modelo de indexación a partir del texto del issue.
Evaluación
- Stack tecnológico
- github-actions, markdown
- Área
- content, documentation, localization, release
- Tipo de issue
- Documentación
- Dificultad
- 5/5
- Tiempo estimado
- Más de una semana
- Estado de actividad
- Estancado
- Claridad
- Necesita aclaración
- Aptitud para principiantes
- 25/100