Members-Serverguide

Differences between revisions 6 and 8 (spanning 2 versions)
⇤ ← Revision 6 as of 2013-03-26 23:37:54 →
Size: 2473
Editor: dsmythies
Comment: To create a serverguide specific version of the generic members notes
← Revision 8 as of 2013-03-27 23:02:57 → ⇥
Size: 3021
Editor: dsmythies
Comment: Just continuing with the editing. Not done yet.
Deletions are marked like this. Additions are marked like this.
Line 4: Line 4:
This page contains some tips for people who are granted permissions to upload directly to the system documentation branches (by becoming members of the [[https://launchpad.net/~ubuntu-core-doc|ubuntu-core-doc]] team). This page is in progress, and is not yet complete. It is also not linked from anywhere yet.
Line 6: Line 6:
== Applying a patch == This page contains tips, how-to notes and examples for documentation committers working with the serverguide.
Line 8: Line 8:
To apply a patch submitted by a contributor: == Merging a Merge Proposal ==
Line 10: Line 10:
 1. Save the patch file in a suitable location, like {{{ubuntu-doc/patches/}}} for example.
 2. Change to the relevant branch on your computer:{{{
cd ubuntu-doc/ubuntu-hardy }}}
 3. Apply the patch file{{{
patch -p0 < patches/patch.diff }}}		 Once a merge proposal has been accepted, it needs to be merged into the main branch:
Line 16: Line 12:
That's it! However, depending on how the patch was created, you made need to cd into the directory where the actual file to be patched resides. Simply cd into that directory, (e.g. {{{ubuntu-hardy/ubuntu/internet/C}}}) before applying the patch.  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"

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.

Merging 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"

Bzr bundles (Merge Proposals) are even easier to apply using the command

$ bzr merge address/to/bundle  (i.e. bzr merge lp:~jdoe/serverguide/some_revision)

Publishing changes

Members of the ubuntu-core-doc team can publish their changes directly to the branches. This is the procedure:

  1. 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.

  2. 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

  3. Then push your commit to the common branch by running

    bzr push lp:~ubuntu-core-doc/ubuntu-docs/name_of_branch

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

For more information about using bound branches, see the bzr website.

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