diff --git a/docs/documentation_style_guide.md b/docs/documentation_style_guide.md index 846fade..3549d83 100644 --- a/docs/documentation_style_guide.md +++ b/docs/documentation_style_guide.md @@ -32,7 +32,7 @@ The sentence after the colon should begin with a capital letter. When translating documentation, these Block indicators should not be translated. Keeps them intact as they are and only translate the block content. For translating the `Type` word, each guide translation should have a `blocktypes.json` file -containing the translations. The following shows an example for german: +containing the translations. The following shows an example for German: ```json { @@ -62,4 +62,18 @@ Find broken links (some false-positives may occur): grep -rniP "\[\[[^\],']+?\][^\]]" docs/guide* grep -rniP "[^\[]\[[^\]\[,']+?\]\]" docs/guide* - \ No newline at end of file +## Attribution of Translators + +The names of the translators will be listed among the guide authors in the +rendered versions of the guide. +Therefor in each guide directory for a different language than english a `translators.json` file +should be created that contains an array of names of the people who have participated in the translation. + +```json +[ + "Jane Doe", + "John Doe" +] +``` + +If you have contributed a significant part to the translation, feel free to send a pull request adding your name. diff --git a/docs/guide-de/translators.json b/docs/guide-de/translators.json new file mode 100644 index 0000000..9e05c89 --- /dev/null +++ b/docs/guide-de/translators.json @@ -0,0 +1,3 @@ +[ + "Carsten Brandt" +] \ No newline at end of file diff --git a/docs/guide-es/translators.json b/docs/guide-es/translators.json new file mode 100644 index 0000000..e5431ad --- /dev/null +++ b/docs/guide-es/translators.json @@ -0,0 +1,6 @@ +[ + "Antonio Ramirez", + "Daniel Gómez Pan", + "'larnu'", + "Luciano Baraglia" +] \ No newline at end of file diff --git a/docs/guide-fr/translators.json b/docs/guide-fr/translators.json new file mode 100644 index 0000000..8e14eb6 --- /dev/null +++ b/docs/guide-fr/translators.json @@ -0,0 +1,5 @@ +[ + "Benoît", + "Kevin LEVRON", + "jaaf" +] \ No newline at end of file diff --git a/docs/guide-pl/translators.json b/docs/guide-pl/translators.json new file mode 100644 index 0000000..b1dbe92 --- /dev/null +++ b/docs/guide-pl/translators.json @@ -0,0 +1,5 @@ +[ + "Bizley", + "Tomek Romik", + "Yupik" +] \ No newline at end of file diff --git a/docs/guide-pt-BR/translators.json b/docs/guide-pt-BR/translators.json new file mode 100644 index 0000000..82ccb34 --- /dev/null +++ b/docs/guide-pt-BR/translators.json @@ -0,0 +1,9 @@ +[ + "Alcir Monteiro", + "Alan Michel Willms Quinot", + "Davidson Alencar", + "Gustavo G. Andrade", + "Jan Silva", + "Lucas Barros", + "Wanderson Bragança" +] \ No newline at end of file diff --git a/docs/guide-ru/translators.json b/docs/guide-ru/translators.json new file mode 100644 index 0000000..59dcea9 --- /dev/null +++ b/docs/guide-ru/translators.json @@ -0,0 +1,4 @@ +[ + "Alexander Makarov", + "and others..." +] \ No newline at end of file