Members-Serverguide
4410
Comment: Initial editing continued...
|
5462
... Continued ...
|
Deletions are marked like this. | Additions are marked like this. |
Line 9: | Line 9: |
This page is not intended for serverguide documentation contributors, who should be using the [[https://wiki.ubuntu.com/DocumentationTeam/SystemDocumentation/UbuntuServerGuide|serverguide documentation contributors reference wiki]] instead. |
|
Line 35: | Line 37: |
When the bzr branch .po files need to be updated: | 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) : |
Line 57: | Line 59: |
== Cycle Related General Edits == | == Series Related General Edits == |
Line 61: | Line 63: |
== New Branch Set Up == | == New Series Set Up == |
Line 67: | Line 69: |
== New Branch Translations Set Up == | == New Series Translations Set Up == |
Line 69: | Line 71: |
This has not been done yet for raring. Notes to come. | Note: not done for raring yet. these notes subject to change and/or completion. |
Line 71: | Line 73: |
== Initialize The Cycle Related Serverguide Contributors Wiki == | After a new serverguide series has been set up, open the "Translations Tab" or go to [[https://translations.launchpad.net/serverguide|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. |
Line 73: | Line 75: |
On a per release cycle basis, the documentation contributors [[https://wiki.ubuntu.com/DocumentationTeam/SystemDocumentation/UbuntuServerGuide|reference wiki]] needs to be intitialized. | Manual input is preferred (input from Matthew East). Doug Question: When is this done? At the same time as the series setup? At string freeze, when the first pass goes to the translators? Do Doc-committers even do this step? == New Series Initialize The Serverguide Contributors Wiki == On a per release cycle basis, the [[https://wiki.ubuntu.com/DocumentationTeam/SystemDocumentation/UbuntuServerGuide|documentation contributors reference wiki]] needs to be intitialized. |
This page is in progress, and is not yet complete. It is also not linked from anywhere yet.
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:
Set up a local working branch:
mkdir sguide-1204 cd sguide-1204 bzr branch lp:serverguide/precise mp_100000 cd mp_100000
Always run the validate script before any changes, just in case something is wrong:
scripts/validate.sh serverguide/C/serverguide.xml
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)
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"
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) :
Create a working branch
bzr branch lp:serverguide/precise precise_po_update
Ask for the entire po set via https://translations.launchpad.net/serverguide/precise/+export
- Wait for the e-mail to come saying that the .po set is ready.
- Get and unpack the file set to some location.
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
Check that the po files are actually newer and that the number of files is the same.
grep PO-Rev *.po | more
- Replace the old .po files with the newer ones. (Do NOT copy the .pot file from the downloaded file set.)
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:
example session, coming
Series Related General Edits
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 (Doug: Can an entity substution be used in that file?). 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....
I wonder if Peter Matulis would be willing to write this part, since he set up the raring branch.
New Series Translations Set Up
Note: not done for raring yet. these notes subject to change and/or completion.
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.
Manual input is preferred (input from Matthew East).
Doug Question: When is this done? At the same time as the series setup? At string freeze, when the first pass goes to the translators? Do Doc-committers even do this step?
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)