Browse Source

added translators.json to the Guide to allow attribution in the rendered guide

see https://github.com/yiisoft-contrib/yiiframework.com/issues/33
tags/2.0.10
Carsten Brandt 8 years ago
parent
commit
98926891a4
  1. 16
      docs/documentation_style_guide.md
  2. 3
      docs/guide-de/translators.json
  3. 6
      docs/guide-es/translators.json
  4. 5
      docs/guide-fr/translators.json
  5. 5
      docs/guide-pl/translators.json
  6. 9
      docs/guide-pt-BR/translators.json
  7. 4
      docs/guide-ru/translators.json

16
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*
## 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.

3
docs/guide-de/translators.json

@ -0,0 +1,3 @@
[
"Carsten Brandt"
]

6
docs/guide-es/translators.json

@ -0,0 +1,6 @@
[
"Antonio Ramirez",
"Daniel Gómez Pan",
"'larnu'",
"Luciano Baraglia"
]

5
docs/guide-fr/translators.json

@ -0,0 +1,5 @@
[
"Benoît",
"Kevin LEVRON",
"jaaf"
]

5
docs/guide-pl/translators.json

@ -0,0 +1,5 @@
[
"Bizley",
"Tomek Romik",
"Yupik"
]

9
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"
]

4
docs/guide-ru/translators.json

@ -0,0 +1,4 @@
[
"Alexander Makarov",
"and others..."
]
Loading…
Cancel
Save