[PATCH 3/6] Update translation documentation for Zanata
Chris Lumens
clumens at redhat.com
Wed May 20 14:43:25 UTC 2015
From: "Brian C. Lane" <bcl at redhat.com>
Related: rhbz#1196721
---
docs/transifex.txt | 129 --------------------------------------------------
docs/translations.txt | 116 +++++++++++++++++++++++++++++++++++++++++++++
2 files changed, 116 insertions(+), 129 deletions(-)
delete mode 100644 docs/transifex.txt
create mode 100644 docs/translations.txt
diff --git a/docs/transifex.txt b/docs/transifex.txt
deleted file mode 100644
index afbc9ce..0000000
--- a/docs/transifex.txt
+++ /dev/null
@@ -1,129 +0,0 @@
-Transifex and anaconda Development
-09-Mar-2011
-by: David Cantrell <dcantrell at redhat.com>
------------------------------------------------------------------------------
-
-Setting up the new transifex-client on your system for anaconda builds.
-
-1) Install the transifex-client package:
- yum install transifex-client
- -or-
- yum --enablerepo=updates-testing install transifex-client
- -or-
- yum --enablerepo=epel-testing install transifex-client
-
-2) Create a Transifex.net account at https://fedora.transifex.net/
- NOTE: This system is not linked to FAS, it's hosted by another company,
- so it requires another account at this time. I'm sure this will change
- in the future, but this is how it is for now.
-
-3) Configure 'tx' on your system:
- tx init
- Accept default host, fill in your username and password generated in #2.
-
-Now tx is set up on your system. The translation files will only be pulled
-when a 'make release' is done. The 'make dist' step will just create a tar
-file of the what we have in our repo. The 'make bumpver' step will also
-push a new anaconda.pot file to Transifex, so any string changes are pushed
-to them on a regular basis.
-
-NOTE: tx pull is slow. This is why I only added it to the 'make bumpver'
-step.
-
-There are some other procedures related to tx that will have to be done
-when we create new branches or when there are translation errors.
-
-
-MAKING A RELEASE
-----------------
-
-git clean -d -x -f
-./autogen.sh && ./configure --disable-static \
---enable-introspection --enable-gtk-doc
-make bumpver # tx pull by dependent po-pull target
-git commit -a -m "New version." # DO NOT run 'git clean -d -x -f' after
-make && make release # signed tag happens after dist now
-
-The process here is mostly the same. I do not recommend that you run
-git clean between 'make bumpver' and 'make release'. The reason is you
-will have to run 'tx pull' again and that's slow, plus translations may
-have changed between the two steps.
-
-The 'make tag' step now runs after 'make dist' in case dist generation
-fails. That way you don't end up with a partially created dist AND a
-bad tag you have to delete.
-
-The 'make scratch' target will also run po-pull to get translations. If
-we need translation files in other targets, we can add po-pull as a
-dependent target.
-
-
-DEALING WITH ERRORS IN *.po FILES
----------------------------------
-
-Translators sometimes introduce errors in the .po files. What we generally
-do is try to fix it if it's an obvious typo, or just revert the change and
-go back to the old po file. Reverting is harder now since we are not
-storing po files in our repo, but in severe cases we can go and fetch the
-last build and pull the affected po file from there and use it to revert the
-changes.
-
-Here's an example of a po file error that will halt a 'make release':
-
- rm -f af.gmo && /usr/bin/msgfmt -c --statistics -o af.gmo af.po
- af.po:7: field `Language-Team' still has initial default value
- af.po:1614: number of format specifications in 'msgid' and 'msgstr[1]' does not match
- /usr/bin/msgfmt: found 1 fatal error
-
-In this case, I am going to the last known good af.po. To update Transifex,
-I do:
-
- cp /path/to/last/known/good/af.po po/af.po
- touch po/af.po
- tx push -t -l af
-
-The touch is necessary because transifex.net uses timestamps to determine
-if it should update its translation data with the po file you are asking
-it to use.
-
-
-CREATING A NEW ANACONDA BRANCH
-------------------------------
-
-When we make a new branch, we need to branch the translation files.
-
-First you need to populate the project with the initial po files. I suggest
-using the ones from the master branch, e.g.:
-
- git checkout master
- git clean -xdf
- tx pull -a
- # leave the *.po files in the po/ subdirectory
- git checkout BRANCH_NAME
-
-Next you need to update the transifex config with the new branch:
-
- tx set --execute --auto-local -r anaconda.BRANCH_NAME -s en -t PO \
- -f po/anaconda.pot "po/<lang>.po"
-
-The last argument is correct as-is, it's not a place where you substitute
-something for <lang>. The BRANCH_NAME will be something other than 'master'.
-For example, when we branch for F-20:
-
- tx set --execute --auto-local -r anaconda.f20-branch -s en -t PO \
- -f po/anaconda.pot "po/<lang>.po"
-
-Check the .tx/config file on the branch to ensure it references the correct
-anaconda.BRANCH_NAME in Transifex and remove the [anaconda.master] block so
-that it doesn't try to push to master and the new branch.
-
-Now you can run:
-
- tx push -s -t
-
-This will push the po files and anaconda.pot from master to the BRANCH_NAME
-resource for anaconda in Transifex. This is just an initial seed that the
-translation team can work with. And since we branch from master, the code
-should be more or less in sync with the po files at branch time.
-
-Don't forget to commit the new .tx/config file to the branch.
diff --git a/docs/translations.txt b/docs/translations.txt
new file mode 100644
index 0000000..50a529d
--- /dev/null
+++ b/docs/translations.txt
@@ -0,0 +1,116 @@
+Translations and anaconda Development
+24-Feb-2015
+by: David Cantrell <dcantrell at redhat.com>
+ Brian C. Lane <bcl at redhat.com>
+-----------------------------------------------------------------------------
+
+Anaconda, as of version 23.1, is using https://fedora.zanata.com for
+translations. You will need an account in order to pull translations until bug
+https://bugzilla.redhat.com/show_bug.cgi?id=1172618 (anonymous pull requests)
+has been resolved.
+
+The zanata-python-client is used by the build scripts, not the full zanata
+package.
+
+
+CLIENT SETUP
+------------
+Setting up the zanata-python-client on your system for anaconda builds.
+
+1) Install the zanata-python-client package:
+ yum install zanata-python-client
+
+2) Create a Zanata account at https://fedora.zanata.org
+ NOTE: This system is linked to FAS, but the 'remember my login' option
+ only appears to work for about an hour, not 7 days as it claims.
+
+3) Navigate to Dashboard->Settings->Client and click 'Generate New API Key'
+
+4) Copy the contents of the Configuration text box to ~/.config/zanata.ini
+ and make sure permissions are 0600.
+
+Now zanata is set up on your system. The translation files will only be pulled
+when a 'make release' is done. The 'make dist' step will just create a tar
+file of the what we have in our repo. The 'make bumpver' step will also push a
+new anaconda.pot file to Zanata, so any string changes are pushed to them on a
+regular basis.
+
+NOTE: zanata pull is slow. This is why I only added it to the 'make bumpver'
+step.
+
+There are some other procedures related to zanata that will have to be done
+when we create new branches or when there are translation errors.
+
+
+MAKING A RELEASE
+----------------
+
+git clean -d -x -f
+./autogen.sh && ./configure --disable-static \
+--enable-introspection --enable-gtk-doc
+make bumpver # zanata pull by dependent po-pull target
+git commit -a -m "New version." # DO NOT run 'git clean -d -x -f' after
+make && make release # signed tag happens after dist now
+
+The process here is mostly the same. I do not recommend that you run
+git clean between 'make bumpver' and 'make release'. The reason is you
+will have to run 'zanata pull' again and that's slow, plus translations may
+have changed between the two steps.
+
+The 'make tag' step now runs after 'make dist' in case dist generation
+fails. That way you don't end up with a partially created dist AND a
+bad tag you have to delete.
+
+The 'make scratch' and 'make po-empty' targets will now create empty
+translation files so that local test builds can be created without needing a
+zanata account.
+
+
+DEALING WITH ERRORS IN *.po FILES
+---------------------------------
+
+Translators sometimes introduce errors in the .po files. What we generally
+do is try to fix it if it's an obvious typo, or just revert the change and
+go back to the old po file. Reverting is harder now since we are not
+storing po files in our repo, but in severe cases we can go and fetch the
+last build and pull the affected po file from there and use it to revert the
+changes.
+
+Here's an example of a po file error that will halt a 'make release':
+
+ rm -f af.gmo && /usr/bin/msgfmt -c --statistics -o af.gmo af.po
+ af.po:7: field `Language-Team' still has initial default value
+ af.po:1614: number of format specifications in 'msgid' and 'msgstr[1]' does not match
+ /usr/bin/msgfmt: found 1 fatal error
+
+In this case, I am going to the last known good af.po. To update Zanata,
+I do:
+
+ cp /path/to/last/known/good/af.po po/af.po
+ zanata push --push-type target --lang af
+
+
+CREATING A NEW ANACONDA BRANCH
+------------------------------
+
+When we make a new branch, we need to branch the translation files.
+
+On https://fedora.zanata.com go to the project and version to use as a base.
+Select 'New Version+' from the hidden drop down menu on the right. Give it a
+name that matches the git branch. eg. f23-branch and select the version to copy
+from (usually master). Wait for it to finish processing documents.
+
+Create a new git branch:
+
+ git checkout master
+ git clean -xdf
+ git checkout BRANCH_NAME
+
+At https://fedora.zanata.com select the new version and then select the
+'Download Config file' from the hidden dropdown menu next to 'Settings'. This
+will download a new zanata.xml file. Replace the zanata.xml file in the root
+directory of anaconda project with this new one.
+
+ git add -u
+ git commit -m "New Zanata config file"
+ git push --set-upstream origin BRANCH_NAME
--
2.2.2
More information about the anaconda-patches
mailing list