Members-Serverguide

Differences between revisions 22 and 23
Revision 22 as of 2013-04-11 15:17:11
Size: 8195
Editor: dsmythies
Comment:
Revision 23 as of 2013-04-12 19:32:45
Size: 8503
Editor: dsmythies
Comment:
Deletions are marked like this. Additions are marked like this.
Line 55: Line 55:
grep PO-Rev *.po | more }}} grep PO-Rev *.po | more }}} However, the above can give misleading results, as the file can change without PO-Revision changing. Similarly, the translations status web page can show misleading information in the "Last Changed" column. So, also check the version of .pot file this .po file is based on:{{{
grep "POT-Cre" *.po | more}}}

This page is in progress, and is not yet complete.

This page contains tips, how-to notes and examples for documentation committers working with the serverguide. Intended as a supplement to, and not a replacement for, the generic Members page.

This page is not intended for serverguide documentation contributors, who should be using the serverguide documentation contributors reference wiki instead.

Executing a Merge Proposal

Once a merge proposal has been accepted, it needs to be merged into the main branch:

  1. Set up a local working branch:

    mkdir sguide-1204
    cd sguide-1204
    bzr branch lp:serverguide/precise mp_100000
    cd mp_100000 
  2. Always run the validate script before any changes, just in case something is wrong:

    scripts/validate.sh serverguide/C/serverguide.xml 
  3. Perform the actual merge and do some checks:

    bzr merge lp:~jdoe/serverguide/some-review
    scripts/validate.sh serverguide/C/serverguide.xml
    bzr diff | more   (some prefer 'bzr cdiff' (from the package 'bzrtools'))
    make serverguide-html
    make serverguide-pdf
    bzr status     (for a summary of the current merge proposal) 
  4. Once everything is in order, which it should be for an approved merge proposal, then complete the job:

    bzr commit --fixes lp:123456 -m 'Edits per MP: #100000; LP: #123456 some notes about whatever; by John Doe'
    bzr push lp:serverguide/precise 

Note that if working with the current release cycle branch the "lp:serverguide" can be used instead of "lp:serverguide/branch_name"

Note that multiple launchpad bug links can be done with one commit line. Example:

bzr commit --fixes lp:123456 --fixes lp:123457 -m 'some notes; by John Smith'

However, serverguide branches can also be linked to bug reports afterwards via the branch code web page (i.e. if forgotten during this step).

Updating the .po files

When the bzr branch .po files need to be updated (Based on reviewing other release cycles, typically this is done just less then 3 weeks after string freeze and before final release. It proably doesn't metter that much because most translations are way way way behind) :

  1. Create a working branch

    bzr branch lp:serverguide/precise precise_po_update 
  2. Ask for the entire po set via https://translations.launchpad.net/serverguide/precise/+export (change the series name as required)

  3. Wait for the e-mail to come saying that the .po set is ready.
  4. Get and unpack the file set to some location.

    gunzip launchpad-export.tar.gz
    tar xvf launchpad-export.tar 
  5. The file names will be serverguide-LN.po (where LN is each lanaguage), but they need to be LN.po:

    rename 's/(serverguide-)(.*)\.po/$2.po/' *.po 
  6. Check that the po files are actually newer and that the number of files is the same.

    grep PO-Rev *.po | more 

    However, the above can give misleading results, as the file can change without PO-Revision changing. Similarly, the translations status web page can show misleading information in the "Last Changed" column. So, also check the version of .pot file this .po file is based on:

    grep "POT-Cre" *.po | more
  7. Replace the old .po files with the newer ones. (Do NOT copy the .pot file from the downloaded file set.)
  8. Check bzr status, commit and push the branch:

    bzr status
    bzr commit -m 'update the po files; by John Doe'
    bzr push lp:serverguide/precise 

Updating the .pot file

Simply run the script to generate a new .pot file and push the result:

scripts/get-pot.sh

On a per release cycle basis, there are a few simple changes required. While they could be done by a documentation contributor via a merge proposal, they tend to fall to documentation committers. Update the various forms of distro information in libs/global.ent. Update the version in libs/ubuntu.xsl for the help link (Entity substitution can not used for libs/ubuntu.xsl). Check the .xml files for any needed version related changes and if automated entity substitution can be used instead.

New Series Set Up

For each release cycle, a new master branch needs to be created in launchpad. Raring in this example.

  1. Push the previous series into a new code branch by running

    bzr push lp:~ubuntu-core-doc/serverguide/raring 
  2. From the main launchpad serverguide page click "Register a series".

  3. Fill in name as "raring", a summary, and fill in ~ubuntu-core-doc/serverguide/raring as the branch.
  4. Back at the main launchpad serverguide page click "Change details".

  5. Change the development focus" to the new series.

New Series Translations Set Up

Note: In progress for raring. These notes subject to change and/or completion.

Make sure the .pot file is current. Pick up the latest .po files, as the starting point, otherwise there might be a great may import errors like this (as happened on raring):

Imported, but with errors: 1597. "This message was updated by someone else after you got the translation file. This translation is now stored as a suggestion, if you want to set it as the used one, go to https://translations.launchpad.net/serverguide/raring/+pots/serverguide/fr/+translate and approve it.":

After a new serverguide series has been set up, open the "Translations Tab" or go to https://translations.launchpad.net/serverguide and on that page, under the "All translatable series" area, there should be a "Set up translations for a series" area with the new series listed. If not, then someone else may have already initialized the tranlations for the series, in which case it should appear in the "All translatable series" list and the "Set up ..." section will not even appear.

Manual input is preferred (input from Matthew East).

This does not need to be done until immediately after the documentation string freeze, when it must be done. It is really a matter of balancing how much the strings are likely to change against giving translators as much time as possible to do their work. In favour of opening translations early, it gives translators more time; but if strings then are changed by the doc-committers in the interim, then translators' work can be wasted. It is fine to open the translations at string freeze, but in a particularly good release when a lot of doc work has been done early in the release, then they could be opened earlier. The reality is usually that both documentors and translators are given so little time at the end of a release to work that things get squeezed.

Go to "Change Synchornization Settings" and "Import Settings" and set it to "Import template and translation files". Save settings. Also request a one-time import. (Doug: was it right to to this?)

Go to the "Configure Translations" page and change the "Translation focus" to the new series.

It might take awhile (maybe several hours), but the translations status pages should become visible with status. Check that the new strings appear as untranslated, they might be hard to find.

New Series Initialize The Serverguide Contributors Wiki

On a per release cycle basis, the documentation contributors reference wiki needs to be intitialized.

UTF-8 Policy

There should be no multi-byte UTF-8 characters in the master .xml source files. Obvioulsy, multi-byte UTF-8 characters are essential for the translated documents. The only multi byte UTF-8 characters in the master source files are two in ubuntu.xsl defining the double >> character used in the HTML link trails, and such is consistent with other Ubuntu docs. To check for garbage bytes:

grep --color='auto' -P -n "[\x80-\xFF]" *.xml

Opening and closing quote characters can still be included via use of <quote> and </quote> tags within the .xml files.

DocumentationTeam/SystemDocumentation/Repository/Members-Serverguide (last edited 2017-12-08 22:45:26 by dsmythies)