Skip to content

Commit c388144

Browse files
committed
Add basic documentation about translating visuals. extend mainter docs.
1 parent 67634ec commit c388144

File tree

1 file changed

+10
-2
lines changed

1 file changed

+10
-2
lines changed

translation/README.md

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -45,6 +45,13 @@ There are a few things you should prepare before starting a translation project.
4545

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

48+
### Translating Visuals (images, mindmap, etc)
49+
50+
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!
51+
52+
- 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).
53+
- 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.
54+
4855
### Translation Quality and Review Process
4956

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

7582
a) determine a translation lead, and add them to the relevant files. See [code change](https://github.com/InnerSourceCommons/InnerSourcePatterns/commit/95b8fc76b64909af5e95bf93fad6e7c105307812)
76-
b) update the GitHub Actions that generate book. See [code change](https://github.com/InnerSourceCommons/InnerSourcePatterns/commit/241bdf2a12c8750c66e71865a770d321cca67511)
77-
c) update the GitHub Actions that generate performs the consistency checks. See [code change](https://github.com/InnerSourceCommons/InnerSourcePatterns/pull/619/commits/fce53091faac83b99de8d699d7672a44810408f0)
83+
b) [book.yml](../.github/workflows/book.yml) - update the GitHub Actions that generate book. See [code change](https://github.com/InnerSourceCommons/InnerSourcePatterns/commit/241bdf2a12c8750c66e71865a770d321cca67511)
84+
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)
85+
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 commit comments

Comments
 (0)