summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorAchilleas Pipinellis <axil@gitlab.com>2017-10-09 11:36:07 +0200
committerAchilleas Pipinellis <axil@gitlab.com>2017-10-09 11:36:07 +0200
commit5a25fc1ed80ef913b9abd30c7decdbcd2dab6676 (patch)
treed583f1fa2804ebfd40bd5909ff6a8d0217342749 /doc
parent75212feefd3e8fba3e59e7c070c6dd0d7d2dd96e (diff)
downloadgitlab-ce-5a25fc1ed80ef913b9abd30c7decdbcd2dab6676.tar.gz
Update i18n docs
Diffstat (limited to 'doc')
-rw-r--r--doc/development/i18n/externalization.md17
-rw-r--r--doc/development/i18n/index.md4
-rw-r--r--doc/development/i18n/translation.md4
3 files changed, 15 insertions, 10 deletions
diff --git a/doc/development/i18n/externalization.md b/doc/development/i18n/externalization.md
index bd0ef39ca62..167260b6e0e 100644
--- a/doc/development/i18n/externalization.md
+++ b/doc/development/i18n/externalization.md
@@ -2,22 +2,21 @@
> [Introduced](https://gitlab.com/gitlab-org/gitlab-ce/merge_requests/10669) in GitLab 9.2.
-For working with internationalization (i18n) we use
-[GNU gettext](https://www.gnu.org/software/gettext/) given it's the most used
-tool for this task and we have a lot of applications that will help us to work
-with it.
+For working with internationalization (i18n),
+[GNU gettext](https://www.gnu.org/software/gettext/) is used given it's the most
+used tool for this task and there are a lot of applications that will help us to
+work with it.
## Setting up GitLab Development Kit (GDK)
-In order to be able to work on the [GitLab Community Edition](https://gitlab.com/gitlab-org/gitlab-ce) project we must download and
-configure it through [GDK](https://gitlab.com/gitlab-org/gitlab-development-kit), we can do it by following this [guide](https://gitlab.com/gitlab-org/gitlab-development-kit/blob/master/doc/set-up-gdk.md).
+In order to be able to work on the [GitLab Community Edition](https://gitlab.com/gitlab-org/gitlab-ce)
+project you must download and configure it through [GDK](https://gitlab.com/gitlab-org/gitlab-development-kit/blob/master/doc/set-up-gdk.md).
-Once we have the GitLab project ready we can start working on the
-translation of the project.
+Once you have the GitLab project ready, you can start working on the translation.
## Tools
-We use a couple of gems:
+The following tools are used:
1. [`gettext_i18n_rails`](https://github.com/grosser/gettext_i18n_rails): this
gem allow us to translate content from models, views and controllers. Also
diff --git a/doc/development/i18n/index.md b/doc/development/i18n/index.md
index e8182ace9c3..4cb2624c098 100644
--- a/doc/development/i18n/index.md
+++ b/doc/development/i18n/index.md
@@ -13,6 +13,8 @@ Translating strings will help complete and improve each language.
## How to contribute
+There are many ways you can contribute in translating GitLab.
+
### Externalize strings
Before a string can be translated, it must be externalized.
@@ -69,6 +71,6 @@ Requests to become a proof reader will be considered on the merits of previous t
If you would like to be added as a proof reader, please [open an issue](https://gitlab.com/gitlab-org/gitlab-ce/issues).
-### Release
+## Release
Translations are typically included in the next major or minor release.
diff --git a/doc/development/i18n/translation.md b/doc/development/i18n/translation.md
index 8687e47ee1c..79707aaf671 100644
--- a/doc/development/i18n/translation.md
+++ b/doc/development/i18n/translation.md
@@ -4,6 +4,8 @@ For managing the translation process we use [Crowdin](https://crowdin.com).
## Using Crowdin
+The first step is to get familiar with Crowdin.
+
### Sign In
To contribute translations at [translate.gitlab.com](https://translate.gitlab.com)
@@ -37,6 +39,8 @@ Remember to **Save** each translation.
## Translation Guidelines
+Be sure to check the following guidelines before you translate any strings.
+
### Technical terms
Technical terms should be treated like proper nouns and not be translated.