Translating the Django documentation into German

Published 14th December 2008

The German Django documentation got outdated after the original documentation was refactored because there were too many changes to track. Now, to follow the new structure, we started to translate and reorganize the documentation from scratch.

Help is always appreciated. Here's a little guide if you want to help translating the Django documentation but don't know how to start.

  1. Fork the main django-de-docs repository. We mostly work in the "releases/1.0.X" branch. If you are unsure about working with Git's remote branches, see below for a quick guide.

  2. Select a document you want to translate. Browse the repository to see which documents are already translated. The "Wer macht was?"-Wikipage shows what people are currently working on.

  3. Translate. Browse the old subversion repository and look if your document has been translated before the docs-refactoring. You might reuse some parts of the old translation. If you're unsure about a translation of a technical term, take a look at the glossary.

  4. Submit your translation. Please make sure to commit your changes in the "releases/1.0.X" branch. After you've pushed into your forked repository, you can send zerok a pull request.

Also, feel free to submit corrections to existing documents.

Working with Git remote branches

Adding the original repository as a remote will make later operations a little easier as you can refer to it with an identifier instead of providing the repository url. The following command will use "upstream" as an identifier.

git remote add upstream git://github.com/zerok/django-docs-de.git

As I already mentioned, most work happens in the "releases/1.0.X" branch. Create a same-named local branch which will track (push and pull) from the remote origin.

git branch --track releases/1.0.X origin/releases/1.0.X

Now you can checkout the branch and start working. Once you've finished, simple commit your changes and "git push" to your remote branch.

Upstream Changes

If changes were applied upstream and you want to merge them into your local branch, you just need to pull from upstream (which will fetch and merge the data), eventually resolve conflicts, and push it to your remote repository.

git pull upstream releases/1.0.X
git push