Commit 5bf41ac3 authored by sajolida's avatar sajolida
Browse files

Merge branch 'doc/10076-fix-translating-with-git' (Closes: #10076)

parents c7f8aa6d effc9dea
...@@ -75,93 +75,109 @@ ask on the [[mailing list for translators|translate#follow-up]], we will be glad ...@@ -75,93 +75,109 @@ ask on the [[mailing list for translators|translate#follow-up]], we will be glad
the Tails system administrators (<tails-sysadmins@boum.org>) to host the Tails system administrators (<tails-sysadmins@boum.org>) to host
your repository. your repository.
2. **Copy the source code from the main repository**
You first need to setup a [[persistent volume|doc/first_steps/persistence]] You first need to setup a [[persistent volume|doc/first_steps/persistence]]
to save the source code. Then navigate to the persistent folder, using the terminal: to save the source code. Then navigate to the persistent folder, using the terminal:
cd ~/Persistent cd ~/Persistent
This example clones an empty repository into the "tails" folder: Get the source code:
git clone git@gitlab.com:Tails/tails.git tails git clone https://git-tails.immerda.ch/tails
2. **Copy the source code from the main repository** This operation requires some time at setup, as it requires to pull the whole repository.
Then setup the remote Tails main repository: 3. **Add your repository**
Navigate to the folder containg the source code, using the terminal:
cd tails cd tails
git remote add tails https://git-tails.immerda.ch/tails
To publish your translations, you need to add the repository set up previously.
The URL of your repository should look like `tails@git.tails.boum.org:elouann/tails`.
If you cannot find the URL of your repository, get in touch with the sysadmins or send an email on the [[mailing list|translate#follow-up]]. Once you got it, add it to the repositories:
git remote add myrepo tails@git.tails.boum.org:elouann/tails
Typing `git remote` should now show two entries: Typing `git remote` should now show two entries:
origin origin
tails myrepo
More specifically, if you type `git remote -v` and you'll see something like this: More specifically, if you type `git remote -v`, you'll see something like this:
origin git@gitlab.com:Tails/tails.git (fetch) myrepo tails@git.tails.boum.org:elouann/tails (fetch)
origin git@gitlab.com:Tails/tails.git (push) myrepo tails@git.tails.boum.org:elouann/tails (push)
tails https://git-tails.immerda.ch/tails (fetch) origin https://git-tails.immerda.ch/tails (fetch)
tails https://git-tails.immerda.ch/tails (push) origin https://git-tails.immerda.ch/tails (push)
"origin" is your own repository, "tails" contains the files of the To check if the repository are correctly configured, run the following command:
main repository once we fetch them. This operation requires some time
at setup, as it requires to pull the whole repository.
git fetch tails master git fetch --all
If you have problem with SSH keys or with the URL of your repository, get in touch with the sysadmins or send an email on the [[mailing list|translate#follow-up]].
3. **Configure your credentials** 3. **Configure your credentials**
Now to setup Git, type: Now to setup Git, type:
git config user.name "Tails developers" git config user.name "Your nickname"
git config user.email "tails@boum.org" git config user.email "Your email adress"
Verify this configuration by typing: Verify this configuration by typing:
git config --list git config --list
4. **Translate!** 4. **Create a branch**
Create a branch for every translation you make, for example, if you want to Create a branch for every translation you make, for example, if you want to
translate the "contribute" page, create a branch named "translation-contribute": translate the "contribute" page, create a branch named `translate/contribute`:
git branch translate/contribute
git checkout translate/contribute
Now typing `git branch` should show a star in front of the active branch:
git branch translation-contribute master
git checkout translation-contribute * translate/contribute
Now typing `git branch` should show a star in front of the active branch. 5. **Translate!**
5. Translate whatever you can in your preferred PO file editor, possibly Poedit. You can use your preferred PO file editor, possibly *Poedit* which is included in Tails.
6. **Save your translations** 6. **Save your translations**
Commit the changes you made to `.po` files: Add your changes, then commit
git add <files> git add -p
git commit <files> git commit
7. **Test your work** 7. **Test your work**
[[Build the wiki locally|contribute/build/website/]] in order to verify [[Build the website locally|contribute/build/website/]] in order to verify
your modifications or to review the translations of somebody else. your modifications or to review the translations of somebody else.
If you need to rework something, go back to point 5, translate and test again. If you need to rework something, go back to step 5, translate, and test again.
8. Merge our main repository into yours. 8. **Merge our main repository into yours**.
Regularly, pull from the master branch of the main repository to update
Regularly, pull from the `master` branch of the main repository to update
your local files. your local files.
`git fetch tails master` only fetches new files, while `git fetch origin master` only fetches new files, while
`git pull tails master` fetches and merges the files.
`git pull origin master` fetches and merges the files.
9. **Publish your modifications** 9. **Publish your modifications**
Push your changes to your online Git repository. Push your changes to your online Git repository:
git push origin <name of branch> git push myrepo <name of branch>
For example, For example,
git push origin translation-contribute git push myrepo translate/contribute
10. Ask other members of your translation team to review your work by writing 10. Ask other members of your translation team to review your work by writing
an email to [[the mailing list for an email to [[the mailing list for
...@@ -171,16 +187,16 @@ ask on the [[mailing list for translators|translate#follow-up]], we will be glad ...@@ -171,16 +187,16 @@ ask on the [[mailing list for translators|translate#follow-up]], we will be glad
11. The reviewer, once happy with the result, should ask on the 11. The reviewer, once happy with the result, should ask on the
[[mailing list for translators|translate#follow-up]] to pull from [[mailing list for translators|translate#follow-up]] to pull from
the branch that was worked on, writing an email with "(pull)" and the language the branch that was worked on, writing an email with "(pull)" and the language
short code in the subject. Ideally, such email would be OpenPGP-signed. short code in the subject. Ideally, such email would be signed with OpenPGP.
Each [[language team|translate#language-teams]] keeps track of their contributors' repositories. Each [[language team|translate#language-teams]] keeps track of the repositories of its contributors.
To add one of these repositories as a `remote` in Git, use the following command line: To add one of these repositories as a `remote` in Git, use the following command line:
git remote add [name] https://git-tails.immerda.ch/[name]/tails.git git remote add [name] https://git-tails.immerda.ch/[name]/tails.git
For example: For example:
git remote add https://git-tails.immerda.ch/mercedes508/tails.git git remote add mercedes508 https://git-tails.immerda.ch/mercedes508/tails.git
# More informations and resources # More informations and resources
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment