Skip to content

Commit 3142c72

Browse files
doc: translation contribution
1 parent 1d09885 commit 3142c72

File tree

1 file changed

+31
-5
lines changed

1 file changed

+31
-5
lines changed

CONTRIBUTING.md

+31-5
Original file line numberDiff line numberDiff line change
@@ -6,16 +6,27 @@ Are you interested to contribute to our open source project? That would be aweso
66

77
The following guide is here to try to guide you through the process of contributing to our project in case you do not know where to get started. If you have further questions, we are happy to help, just ping us on our [Slack](https://join.slack.com/t/deckdeckgo/shared_invite/enQtNzM0NjMwOTc3NTI0LTBlNmFhODNhYmRkMWUxZmU4ZTQ2MDJiNjlmYWZiODNjMDU5OGRjYThlZmZjMTc5YmQ3MzUzMDlhMzk0ZDgzMDY) channel.
88

9+
## Table of contents
10+
11+
- [How to get Involved](#how-to-get-involved)
12+
- [Technical facts](#technical-facts)
13+
- [Issues](#issues)
14+
- [Bugs and features requests](#bugs-and-features-requests)
15+
- [Translation](#translation)
16+
917
## How to get Involved
1018

11-
Everyone is welcomed to contribute to our projects, no matter how experienced you are. [DeckDeckGo] was an important learning experience for ourselves and we would be happy if contributing to our project is also profitable to you in terms of learning.
19+
Everyone is welcomed to contribute to our projects, no matter how experienced you are. [DeckDeckGo] was an important learning experience for ourselves and, we would be happy if contributing to our project is also profitable to you in terms of learning.
20+
1221
## Technical facts
1322

1423
[DeckDeckGo] is a mix of applications, components, functions and infrastructure. You could have a look to our [README](README.md) which lists all of these.
1524

1625
In short summary, all our applications and components are developed with [Stencil.JS](https://stenciljs.com) Web Components.
17-
18-
On the other side, our publication engine is developed with [Haskell](https://www.haskell.org/), [Nix](https://nixos.org/nix/) and [Terraform](https://www.terraform.io/).
26+
27+
Our website is implemented with [Gatsby](https://www.gatsbyjs.com/).
28+
29+
On the other side, our publication engine is developed with [Haskell](https://www.haskell.org/), [Nix](https://nixos.org/nix/) and [Terraform](https://www.terraform.io/).
1930

2031
## Issues
2132

@@ -27,6 +38,21 @@ In any case, ping us to get start, your help would be super appreciated!
2738

2839
## Bugs and features requests
2940

30-
Some bugs (sh*t happens) might not yet been reported. Likewise, your awesome ideas to make [DeckDeckGo] better are always wanted. Therefore don't hesitate to open new [issues](https://github.com/deckgo/deckdeckgo/issues) but if you are unsure about if it's the right place or if you would like to discuss it first, go to [Slack](https://join.slack.com/t/deckdeckgo/shared_invite/enQtNzM0NjMwOTc3NTI0LTBlNmFhODNhYmRkMWUxZmU4ZTQ2MDJiNjlmYWZiODNjMDU5OGRjYThlZmZjMTc5YmQ3MzUzMDlhMzk0ZDgzMDY) for that purpose.
41+
Some bugs (sh\*t happens) might not yet been reported. Likewise, your awesome ideas to make [DeckDeckGo] better are always wanted. Therefore don't hesitate to open new [issues](https://github.com/deckgo/deckdeckgo/issues) but if you are unsure about if it's the right place or if you would like to discuss it first, go to [Slack](https://join.slack.com/t/deckdeckgo/shared_invite/enQtNzM0NjMwOTc3NTI0LTBlNmFhODNhYmRkMWUxZmU4ZTQ2MDJiNjlmYWZiODNjMDU5OGRjYThlZmZjMTc5YmQ3MzUzMDlhMzk0ZDgzMDY) for that purpose.
42+
43+
## Translation
44+
45+
We are in the making of adding i18n to our applications. These following are those which can be currently translated.
46+
47+
We would be grateful to get your help to translate our apps!
48+
49+
### Site
50+
51+
The new website of [DeckDeckGo] supports i18n. To provide a new language with a Pull Request, follow these steps:
52+
53+
1. Copy each [pages](https://github.com/deckgo/deckdeckgo/tree/master/site/src/pages/) to their new languages. For example `index.en.js` to `index.fr.js` to create a French page.
54+
2. Translate the text of the pages "index, enterprise and discover" in their related [json](https://github.com/deckgo/deckdeckgo/tree/master/site/src/assets/i18n/) data.
55+
3. Translate all other pages directly in their related Javascript files (we did not extract the text from the "simple" page).
56+
4. Provide a translation for the [meta](https://github.com/deckgo/deckdeckgo/blob/master/site/gatsby-config.js) description.
3157

32-
[DeckDeckGo]: https://deckdeckgo.com
58+
[deckdeckgo]: https://deckdeckgo.com

0 commit comments

Comments
 (0)