Skip to content
This repository was archived by the owner on Feb 6, 2024. It is now read-only.

Commit 3790baa

Browse files
docs: translation
1 parent f054e56 commit 3790baa

File tree

1 file changed

+23
-2
lines changed

1 file changed

+23
-2
lines changed

CONTRIBUTING.md

Lines changed: 23 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -42,10 +42,23 @@ Some bugs (sh\*t happens) might not yet been reported. Likewise, your awesome id
4242

4343
## Translation
4444

45-
We are in the making of adding i18n to our applications. These following are those which can be currently translated.
46-
4745
We would be grateful to get your help to translate our apps!
4846

47+
### Editor
48+
49+
The selection or detection of the language is not yet implemented in our editor. As soon as someone contributes with a language other than English, we will be happy to develop such function.
50+
51+
Meanwhile, the online editor ([studio](https://github.com/deckgo/deckdeckgo/tree/master/studio)) can be translated as following:
52+
53+
1. Translate each keys in [en.json](https://github.com/deckgo/deckdeckgo/blob/master/studio/src/assets/i18n/en.json)
54+
2. Once finished, copy this file to a new filename reflecting the language (such as for example `fr.json` for French)
55+
3. Revert the changes in `en.json`
56+
4. Provide a PR
57+
58+
Translations are handled in JSON files but, as we are consuming these through a store, their representation have to exist as interfaces.
59+
To ease the process we have developed a script which extract the declarations automatically.
60+
In case you would add new keys, run `npm run i18n` to generate the interfaces.
61+
4962
### Site
5063

5164
The new website of [DeckDeckGo] supports i18n. To provide a new language with a Pull Request, follow these steps:
@@ -55,4 +68,12 @@ The new website of [DeckDeckGo] supports i18n. To provide a new language with a
5568
3. Translate all other pages directly in their related Javascript files (we did not extract the text from the "simple" page).
5669
4. Provide a translation for the [meta](https://github.com/deckgo/deckdeckgo/blob/master/site/gatsby-config.js) description.
5770

71+
### Remote
72+
73+
The remote control is not yet translated. If you think that's a must, let us now!
74+
75+
### Docs
76+
77+
We don't plan to translate the documentation for developers, it seems like quite a big task. That being said, we are welcoming contributions. If you are up to, for sure that would be awesome!
78+
5879
[deckdeckgo]: https://deckdeckgo.com

0 commit comments

Comments
 (0)