Skip to content

Commit 34e370a

Browse files
Added localization docs
1 parent 8a0d2c2 commit 34e370a

File tree

9 files changed

+47
-0
lines changed

9 files changed

+47
-0
lines changed

docs/localization.mdx

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
---
2+
id: localization
3+
title: Localization
4+
displayed_sidebar: mainSideBar
5+
---
6+
7+
You want to help translate one of our plugins? Here you'll learn how.
8+
9+
We are using a tool called GitLocalize to manage translations for LifeStealZ. If you want to contribute to the translations, you'll need to sign in to [GitLocalize](https://gitlocalize.com/) with a GitHub Account. If you don't already have one, you can create one [here](https://github.com/signup).
10+
11+
## Translateable Plugins
12+
13+
Here is a list of our plugins that are currently using GitLocalize for translations:
14+
15+
- [LifeStealZ](https://gitlocalize.com/repo/9581)
16+
- [ServerLinksZ](https://gitlocalize.com/repo/10273)
17+
- [CookieClickerZ](https://gitlocalize.com/repo/10275)
18+
- [TimberZ](https://gitlocalize.com/repo/10274)
19+
20+
## How to contribute
21+
22+
To start translating, follow these steps:
23+
24+
1. Go to the GitLocalize page of the plugin you want to translate.
25+
2. Click on the "Sign in with GitHub" button and authorize GitLocalize to access your GitHub account.
26+
3. Once signed in, you'll see a list of languages. Click on the language you want to translate.
27+
4. You will see a list of files that can be translated. Click on a file to start translating.
28+
5. For each string, you can enter your translation in the text box provided. Make sure to keep the original meaning and context of the string.
29+
6. After you are done translating, create a review request by clicking the yellow button in the top right corner.
30+
31+
<img src="/img/localization.gif" alt='localization tutorial' style={{borderRadius: "12px"}}></img>
32+
33+
If the language, you want to translate to is not yet present in the list, please open a ticket on the [Discord](https://strassburger.org/discord).
34+
35+
## Discord Role
36+
37+
When you have contributed to translations, you can request a Translator role in the [Discord Server](https://strassburger.org/discord). This role will give you access to the #translations channel, where you can discuss translations with other translators and the plugin developers.

sidebars.ts

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -54,15 +54,22 @@ const sidebars: SidebarsConfig = {
5454
},
5555
],
5656
},
57+
{
58+
type: "doc",
59+
id: "localization",
60+
className: "style_globe",
61+
},
5762
{
5863
type: "link",
5964
href: "https://github.com/ZetaPlugins",
6065
label: "GitHub",
66+
className: "style_github",
6167
},
6268
{
6369
type: "link",
6470
href: "https://strassburger.org/discord",
6571
label: "Discord",
72+
className: "style_discord",
6673
},
6774
],
6875

static/img/localization.gif

4.37 MB
Loading

static/img/sidebar/discord.png

852 Bytes
Loading

static/img/sidebar/github.png

1.07 KB
Loading

static/img/sidebar/globe.png

596 Bytes
Loading

static/img/sidebar/link.png

605 Bytes
Loading

static/img/sidebar/puzzle.png

536 Bytes
Loading

static/localization.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
If you want to contribute, please refer to [this Wiki entry](hhttps://docs.zetaplugins.com/localization).
2+
3+
If the language you want to translate isn't in this list, please contact us on [Discord](https://strassburger.org/discord).

0 commit comments

Comments
 (0)