-
Notifications
You must be signed in to change notification settings - Fork 23
How to contribute translations for the c:geo FAQ
The c:geo FAQ is part of our webpage which is hosted in this Github Repository. The FAQ is available in different languages, the correct language is selected by the browser preference or user selection.
If you want to contribute in translation of the FAQ to other languages, the following chapters describe how to do that.
The multi-language FAQ source file in YML format can be found in our repository: https://github.com/cgeo/cgeo.github.io/blob/master/_data/faq.yml
As you will see, when looking at this file, it contains a rather simple syntax for each chapter and item.
Each item itself can contain different languages preceeded by the language identifier (e.g. de for german, en for english, etc.).
In order to add a translation for an existing item, you just need to append the matching language identifier and the correpsonding translation. This can be done item by item. If an item is not available in the users prefered language, english will be used as fallback.
As the FAQ source file is hosted on Github, you can use the Github functions for editing and submitting us your suggested translations.
If you are already familiar with Git, the following might be known for you or you might even have better possibilities to use it.
Here is short descriptions about the basic way (using the Github webpage) to contribute Translations.
Using the Fork button on the upper right of our website repository you will create a copy of all the data into your personal repository.
After forking the repository you will now have a complete copy of our webpage in your personal repository with the name <Your username>/cgeo.github.io.
Now you should go to the settings of this repository and change the name of it from cgeo.github.io to <your username>.github.io.
By doing this your personal webpage copy will be availble for preview under the URL http://yourusername.github.io which allows a preview of all changes you will do to your repository.
Remark:
You can ignore possible error messages or error mails from Github stating The CNAME www.cgeo.org is already taken.
After this preparation you are ready to work on the FAQ.
You will find in the sub folder /_data with the name FAQ.yml and can just use the Github webpage editor to modify it. Once done you have to select Commit changes to save the changes to your repository and after a few seconds they should show up on your URL mentioned above.
Repeat this steps as you like to continously work on the FAQ translation.
Once you are done with your translation task you have to create a New pull request in the corresponding menu section.
The base fork should be cgeo/cgeo.github.io branch master, the head fork has to be your own repository.
Once you send us the pull request we will review it, possibly request changes and finally merge it to our webpage code.