Skip to content

Commit

Permalink
Add basic documentation about translating visuals. extend mainter docs.
Browse files Browse the repository at this point in the history
  • Loading branch information
spier committed Nov 18, 2023
1 parent 67634ec commit c388144
Showing 1 changed file with 10 additions and 2 deletions.
12 changes: 10 additions & 2 deletions translation/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,13 @@ There are a few things you should prepare before starting a translation project.

However, since git does not create empty folders, it is better to create directories accordingly or add `.keep` files to keep folders.

### Translating Visuals (images, mindmap, etc)

Most of the translations have not translated the text in the visuals (e.g. in images, the mindmap, etc). However if you like, you can!

- To translate the mindmap, create a new folder similar to [pattern-categorization/gl](../pattern-categorization/gl/). Then edit the file `innersource-program-mind-map.md` in there, and run the scripts as explained [here](../pattern-categorization/README.md).
- To add translated visuals, add a subfolder in `assets/img`, see [assets/img/gl/](../assets/img/gl/) as an example. Make sure that in the markdown files of your patterns you link to the correct image files.

### Translation Quality and Review Process

We consider it best practice to have **at least one native speaker** review the translation.
Expand Down Expand Up @@ -73,5 +80,6 @@ If you are just creating a new translation you do not need this information!
When a new translation is added, there are a couple of tasks to do:

a) determine a translation lead, and add them to the relevant files. See [code change](https://github.com/InnerSourceCommons/InnerSourcePatterns/commit/95b8fc76b64909af5e95bf93fad6e7c105307812)
b) update the GitHub Actions that generate book. See [code change](https://github.com/InnerSourceCommons/InnerSourcePatterns/commit/241bdf2a12c8750c66e71865a770d321cca67511)
c) update the GitHub Actions that generate performs the consistency checks. See [code change](https://github.com/InnerSourceCommons/InnerSourcePatterns/pull/619/commits/fce53091faac83b99de8d699d7672a44810408f0)
b) [book.yml](../.github/workflows/book.yml) - update the GitHub Actions that generate book. See [code change](https://github.com/InnerSourceCommons/InnerSourcePatterns/commit/241bdf2a12c8750c66e71865a770d321cca67511)
c) [i18n-consistency-checker.yaml](../.github/workflows/i18n-consistency-checker.yaml) - update the GitHub Actions that does the consistency checks. See [code change](https://github.com/InnerSourceCommons/InnerSourcePatterns/pull/619/commits/fce53091faac83b99de8d699d7672a44810408f0)
d) (optional) [generate-mindmap.yml](../.github/workflows/generate-mindmap.yml) - if the mindmap was translated too, you need to update the GitHub Actions that regenerates the mindmap as well

0 comments on commit c388144

Please sign in to comment.