Translating Pro Git (2nd Edition)
The translations are managed in a decentralized way. Each translation team maintains their own project. Each translation is in its own repository, the Pro Git team simply pulls the changes and builds them into the https://git-scm.com website when ready.
General guidance for translating Pro Git
Pro Git is a book about a technical tool, therefore translating it is difficult compared to a non-technical translation.
The following are guidelines to help you on your way:
- Before you begin, read the whole Git Pro book in English, so that you're aware of the content, and are familiar with the style used.
- Ensure you have a good working knowledge of git, so that explaining the technical terms is doable.
- Stick to a common style and format for the translation.
- Be sure to read and understand the basics of Asciidoc formatting. Not following the asciidoc syntax can lead to problems with building/compilation of the pdf, epub and html files needed for the book.
Translating the book to another language
Helping with a existing project
- Check for an already existing project in the following table.
- Go to the project's page on GitHub.
- Open an issue, introduce yourself and ask where you can help.
Starting a new translation
If there is no project for your language, you can start your own translation.
Base your work on the second edition of the book, available here. To do so:
- Pick the correct ISO 639 code for your language.
- Create a GitHub organization, for example:
progit2-[your code]on GitHub.
- Create a project
- Copy the structure of progit/progit2 (this project) in your project and start translating.
Updating the status of your translation
On https://git-scm.com, the translations are divided into three categories. Once you have reached one of these levels, contact the maintainers of https://git-scm.com/ so that they can pull the changes.
|Translation started for||Introduction translated, not much else.|
|Partial translations available in||up to chapter 6 has been translated.|
|Full translation available in||the book is (almost) fully translated.|
Continuous integration with Travis CI
Travis CI is a continuous integration service that integrates with GitHub. Travis CI is used to ensure that a pull-request doesn't break the build or compilation. Travis CI can also provide compiled versions of the book.
Setting up Travis CI requires administrative control over the repository.
Registering for Travis continuous integration
- Register a Travis account here.
- Register your project in Travis. Please refer to the Travis documentation for more information.
Setting up your repository for continuous integration
Travis CI works by scanning your project's root directory for a file named
.travis.yml and following the 'recipe' that it contains. The good news is: there's already a working
.travis.yml file in the Pro Git 2 source here.
Copy that file, and put it in your working directory. Commit the .yml file and push it to your translation repository; that should fire up a compilation and a check of the book's contents.
Setting up a publication chain for e-books
This is a technical task, please ping @jnavila to get started with epub publication.
Beyond Pro Git
Translating the book is the first step. Once this is finished, you could consider translating the user interface of Git itself.
This task requires a more technical knowledge of the tool than the book. Hopefully, after having translated the full book content, you can understand the terms used in the application. If you feel technically up to the task, the repo is here and you just have to follow the guide.
Beware though that
- you'll need to use more specific tools to manage localization po files (such as editing them with poedit and merging them. You might need to compile git in order to check your work.
- a basic knowledge of how translating applications works is required, which is significantly different from translating books.
- the core Git project uses more stringent procedures to accept contributions, be sure to abide by them.