Members-Serverguide
|
Size: 3965
Comment:
|
Size: 3825
Comment: Edits continued...
|
| Deletions are marked like this. | Additions are marked like this. |
| Line 54: | Line 54: |
| Members of the ubuntu-core-doc team can publish their changes directly to the branches. This is the procedure: 0. First, update your branch to the current version by running{{{ bzr pull lp:~ubuntu-core-doc/ubuntu-docs/name_of_branch}}} '''Note''': please do not use {{{bzr merge}}} for updating your branch. 0. Then make your changes and commit them with{{{ bzr commit -m "Description of changes"}}} '''Note''': it is helpful if the description of the changes uses a short description that can later be used in the changelog for the package. If a bug is fixed, please include the bug number in the description in this format: {{{LP: #bugnumber}}}. You can also associate the branch with the bug in Launchpad by including this in your commit command: {{{--fixes lp:bugnumber}}} 0. Then push your commit to the common branch by running{{{ bzr push lp:~ubuntu-core-doc/ubuntu-docs/name_of_branch}}} |
Simply run the script to generate a new .pot file and push the result:{{{ example session, coming }}} |
| Line 64: | Line 57: |
| We recommend that members use the concept of ''Bound Branches'' so that the {{{bzr commit}}} command sends your changes directly to the appropriate branch on Launchpad. That will avoid the need for step 3 above. You can bind a branch by running{{{ bzr bind lp:~ubuntu-core-doc/ubuntu-doc/name_of_branch}}} |
== Cycle Related General Edits == |
| Line 67: | Line 59: |
| For more information about using bound branches, see [[http://bazaar-vcs.org/BzrUsingBoundBranches|the bzr website]]. | 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 Branch 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 Branch Translations Set Up == This has not been done yet for raring. Notes to come. == Initialize The Cycle Related Serverguide Contributors Wiki == On a per release cycle basis, the documentation contributors [[https://wiki.ubuntu.com/DocumentationTeam/SystemDocumentation/UbuntuServerGuide|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.
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:
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
Cycle 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 Branch 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 Branch Translations Set Up
This has not been done yet for raring. Notes to come.
Initialize The Cycle Related Serverguide Contributors Wiki
On a per release cycle basis, the documentation contributors reference wiki needs to be intitialized.
DocumentationTeam/SystemDocumentation/Repository/Members-Serverguide (last edited 2017-12-08 22:45:26 by dsmythies)