add screenshots and basic text around

This commit is contained in:
Ewald Arnold 2019-11-11 16:26:10 +01:00
parent c10f37f1cb
commit 18c14940d1
48 changed files with 182 additions and 53 deletions

View File

@ -1,56 +1,24 @@
# Primer on adding or updating a language file used in Human Connection
![Let's get together](https://raw.githubusercontent.com/Human-Connection/Human-Connection/master/.gitbook/assets/lets_get_together.png "Let's get together")
## Get the current files as base for changes
There are basically two ways to translate the messages for the Human Connection
website:
* Checkout the current repository if you have not done yet
* The easier way for the so-called *regular users* with no programming knowledge
or even an understanding of version control system.
[Guideline for volunteers using lokalise](lokalise-user/README.md)
* The second way might be better suited for people with programming background.
Especially programmers might like this way to immediately update the messages
related to their source contributions.
[Translate manually using the git repository](translate-manually/README.md)
* In case you want to help maintain the translation environment on lokalise
you might want to read the following section to get an idea about those tasks.
git clone https://github.com/Human-Connection/Human-Connection.git
[Administrative tasks on lokalise for Human-Connection](lokalise-admin/README.md)
* Update an already existing repository to the most recent state
git checkout master
git pull upstream master
* Create a branch for your coming changes based on the language code for your language.
For a list of all the codes based on ISO-639 see [Wikipedia](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes).
Use the two-letter code in column *639-1* like *en* or *de*.
The branch name should help recognise what is happing in it. As a suggestion you could use the following pattern:
* Start with _update_ for updates, _new_ for new languages
* One minus sign
* Your two-letter language code
* Optionally another minus sign and short details if needed. Maybe a date or a release number if appropriate.
* Do not use spaces in the branch name, replace them with underscores instead.
For example: update-it-rev_1.2.3
git checkout -b update-it-rev_1.2.3
## Add a new language
git add it.json
blabla
## Update an existing language file
blabla
## Release your changes
* Upload your changes to the offical repository
git push origin update-it-rev_1.2.3
* Create a pull request for your branch on GitHub by visiting the according link in your browser:
https://github.com/Human-Connection/Human-Connection/pull/new/update-it-rev_1.2.3
If everything goes well, the maintainers will accept your request. Otherwise they will
notify via the usual ways Github supports. Additionally all the messages appear on the above web site.
After your Pull Request is accepted on merged into the official part you should move your
local repository back to master as well and delete the temporary branch:
git checkout master
git branch -D update-it-rev_1.2.3
If you still want to help out after reading everything ;-) visit the
[developer's chat at Discord](https://discordapp.com/invite/DFSjPaX). Introduce yourself by clicking
*#introduce-yourself* on the left and mention *@@Mentor* to get you onboard.

View File

@ -1,2 +1,31 @@
![Let's get together](https://raw.githubusercontent.com/Human-Connection/Human-Connection/master/.gitbook/assets/lets_get_together.png "Let's get together")
# Administrative tasks on lokalise for Human-Connection
![Download translations from lokalise](lokalise-admin-download.png)
![General settings part 1](lokalise-admin-generallower.png)
![General settings part 2](lokalise-admin-generalupper.png)
![Glossary for common expressions](lokalise-admin-glossary.png)
![Integrations](lokalise-admin-integrations.png)
![Edit integrations](lokalise-admin-integrationsedit.png)
![Integrations sections](lokalise-admin-integrationsselect.png)
![People](lokalise-admin-people.png)
![Quality checks](lokalise-admin-qachecks.png)
![Screeshots](lokalise-admin-screenshots.png)
![Snapshot](lokalise-admin-snapshots.png)
![Create a task](lokalise-admin-taskcreate.png)
![Task options](lokalise-admin-taskoptions.png)
![Task scope](lokalise-admin-taskscope.png)

Binary file not shown.

Before

Width:  |  Height:  |  Size: 141 KiB

After

Width:  |  Height:  |  Size: 107 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 54 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 60 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 108 KiB

After

Width:  |  Height:  |  Size: 50 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 70 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 26 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 48 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 173 KiB

After

Width:  |  Height:  |  Size: 41 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 80 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 222 KiB

After

Width:  |  Height:  |  Size: 158 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 43 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 91 KiB

After

Width:  |  Height:  |  Size: 24 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 94 KiB

After

Width:  |  Height:  |  Size: 27 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 97 KiB

After

Width:  |  Height:  |  Size: 30 KiB

View File

@ -1 +1,55 @@
# Guideline for uses to help translate Human-Connection
![Let's get together](https://raw.githubusercontent.com/Human-Connection/Human-Connection/master/.gitbook/assets/lets_get_together.png "Let's get together")
# Translating Human-Connection
## Guideline for volunteers using lokalise
If you don't already have an account, register yourself at
[lokalise.co](https://lokalise.co/signup).
![Register account](lokalise-user-register.png "Register on lokalise.co")
Lokalise is earning money by providing paid services, but to translate for
Human-Connection the free account is enough. After registration you get 30 days
of trial period for the professional services. After that time you get a notice
that your trial account expired. You can safely ignore this message as the free
account related to Human-Connection still continues.
The next step is fill in some details. Usually you choose *translator* as role.
If you don't represent a company you can enter *myself* or something else you
find applicable.
![Select your role](lokalise-user-role.png "Select your role")
Once your new account is verified, you can join
[Human-Connection](https://lokalise.co/public/556252725c18dd752dd546.13222042/)
![Join the Human-Connection project](lokalise-user-join.png "Join the Human-Connection project")
After selecting *Join this project* you choose which language you want to translate to.
If you are familiar with more than one language, you might choose *All*. So you can later
select any language to translate to or use as a reference language to translate from.
If you select only one language, you can at a later point let one of the adminstrators
add another languate to your personal pool.
![Select your translation language(s)](lokalise-user-selectlang.png "Select your language(s)")
When selecting a reference language you should keep in mind, that English is the projects main
language, to certain degree also German. All translations should mainly use these two as reference.
If you are familiar with anther language that had some time to mature, you could switch to maybe
get a better idea for tricky translations.
If in doubt about the intended maining of an entry you should ask at the
[developer's chat at Discord](https://discordapp.com/invite/DFSjPaX). Introduce yourself by clicking
*#introduce-yourself* on the left and mention *@@Mentor* to get you onboard.
After that you are ready to translate.
![Translate simple entries](lokalise-user-translate.png "Translate simple entries")
![Translation with a named variable](lokalise-user-translate-token.png "Translation with a named variable")
![Translation with a link](lokalise-user-translate-link.png "Translation with a link")
![Handle translation warnings](lokalise-user-translate-warning.png "Handle translation warnings")

Binary file not shown.

After

Width:  |  Height:  |  Size: 58 KiB

Binary file not shown.

Binary file not shown.

After

Width:  |  Height:  |  Size: 23 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 22 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 19 KiB

Binary file not shown.

Binary file not shown.

After

Width:  |  Height:  |  Size: 9.1 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 45 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 36 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 23 KiB

View File

@ -0,0 +1,78 @@
![Let's get together](https://raw.githubusercontent.com/Human-Connection/Human-Connection/master/.gitbook/assets/lets_get_together.png "Let's get together")
# Translating Human-Connection using the git repository
## Get the current files as base for changes
* Checkout the current repository if you have not done yet
```shell
git clone https://github.com/Human-Connection/Human-Connection.git
```
* Update an already existing repository to the most recent state
```shell
git checkout master
git pull upstream master
```
* Create a branch for your coming changes based on the language code for your language.
For a list of all the codes based on ISO-639 see [Wikipedia](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes).
Use the two-letter code in column *639-1* like *en* or *de*.
The branch name should help recognise what is happing in it. As a suggestion you could use the following pattern:
* Start with _update_ for updates, _new_ for new languages
* One minus sign
* Your two-letter language code
* Optionally another minus sign and short details if needed. Maybe a date or a release number if appropriate.
* Do not use spaces in the branch name, replace them with underscores instead.
For example: update-it-rev_1.2.3
```shell
git checkout -b update-it-rev_1.2.3
```
## Add a new language
```shell
git add it.json
```
blabla
## Update an existing language file
blabla
## Release your changes
* Upload your changes to the offical repository
```shell
git push origin update-it-rev_1.2.3
```
* Create a pull request for your branch on GitHub by visiting the according link in your browser:
https://github.com/Human-Connection/Human-Connection/pull/new/update-it-rev_1.2.3
If everything goes well, the maintainers will accept your request. Otherwise they will
notify via the usual ways Github supports. Additionally all the messages appear on the above web site.
After your Pull Request is accepted on merged into the official part you should move your
local repository back to master as well and delete the temporary branch:
```shell
git checkout master
git branch -D update-it-rev_1.2.3
```
If you get stuck between commits and pulls, thw following two commands force a return to
the most recent remote state:
```shell
git fetch origin
git reset --hard origin/master
```