Submitting

Differences between revisions 2 and 8 (spanning 6 versions)
Revision 2 as of 2008-10-15 20:52:20
Size: 1823
Editor: 79-72-17-225
Comment: use sysdoc menubar
Revision 8 as of 2014-07-02 21:59:17
Size: 2281
Editor: knome
Comment:
Deletions are marked like this. Additions are marked like this.
Line 1: Line 1:
<<Include(DocumentationTeam/SystemDocumentation/MenuBar)>> <<Include(DocumentationTeam/MenuBar)>>
<<Include(
DocumentationTeam/MeetingBanner)>>
Line 3: Line 4:
= Making a patch = = Submitting your Changes =
Line 9: Line 10:
Preparing a patch is easy. You can make a patch for a single file or a group of files that have been modified. See also:

 * [[https://wiki.ubuntu.com/DocumentationTeam/SystemDocumentation/UbuntuDesktopGuide|Ubuntu Desktop Guide Single Page]]
 * [[https://wiki.ubuntu.com/DocumentationTeam/SystemDocumentation/UbuntuServerGuide|Ubuntu ServerGuide Single Page]]

The first step is to save your changes locally.
Line 12: Line 18:
 1. Issue the {{{bzr update}}} command. This updates your working copy with changes from the repository. Check for conflicts and resolve them.
 1. Issue the {{{bzr status}}} command. This shows the status of files. Ensure that all conflicts are resolved.
 1. Issue the command {{{bzr diff > diffname.txt}}}
 (!) If you wish to include your own name and a narrative for your change, you should create a ''bundle'' rather than a patch. To do this, issue these commands instead of the command at step 4 above:{{{
$ bzr commit -m "your narrative here"
$ bzr bundle > diffname.txt}}}
 1. Issue the {{{bzr update}}} command. This updates your working copy with changes from the repository. Check for conflicts and resolve them. It is a good idea to ensure that your branch is up to date before editing any files.
 1. Issue the {{{bzr status}}} command. This shows the status of files which you have edited. Ensure that all conflicts are resolved.
 1. Commit your changes locally by running:{{{
$ bzr commit}}}
  bzr will prompt you to give a narrative to describe your change. Please be as detailed as possible. If your change addresses a Launchpad bug, include the bug number in the format "LP: #123456".
Line 19: Line 24:
This creates the file {{{diffname.txt}}}, which contains the differences between the working copy and repository revisions of the modified files. The next step is to publish your changes for the Documentation Team to review. Depending on which project your are working on:
{{{
$ bzr push lp:~yourusername/ubuntu-docs/branchname}}}
{{{
$ bzr push lp:~yourusername/serverguide/branchname}}}
  "branchname" should be a short word which describes the branch.
Line 21: Line 31:
You should send the patch/bundle to the team [[DocumentationTeam/Contact|mailing list]] or attach it to a relevant bug report. If you have a mentor, copy them into the email and ask them to review it. Visit https://code.launchpad.net/~ and select the branch you just published. Click "Propose for Merging." You can leave the reviewer blank as the Ubuntu Documentation Committers will automatically be notified of your merge.
Line 25: Line 35:
After you get used to Doc``Book, bzr and the DocumentationTeam, you are very likely to be offered an account so that you can write to the repository as well. After you get used to Mallard, bzr and the DocumentationTeam, you are very likely to be offered an account so that you can write to the repository as well.

A Documentation Team meeting is planned for the first Tuesday of every month @ 17:00 UTC.

Freezes for Bionic – String Freeze March 29 – Non-language packs April 12

Submitting your Changes

Once you have made a change to a document and checked your work, the next step is to submit your change to the DocumentationTeam.

Note: It is generally a better idea to make several small changes and send them individually than it is to make one big change.

See also:

The first step is to save your changes locally.

  1. Go to the top level of the branch you are working on.
  2. Issue the bzr update command. This updates your working copy with changes from the repository. Check for conflicts and resolve them. It is a good idea to ensure that your branch is up to date before editing any files.

  3. Issue the bzr status command. This shows the status of files which you have edited. Ensure that all conflicts are resolved.

  4. Commit your changes locally by running:

    $ bzr commit
    • bzr will prompt you to give a narrative to describe your change. Please be as detailed as possible. If your change addresses a Launchpad bug, include the bug number in the format "LP: #123456".

The next step is to publish your changes for the Documentation Team to review. Depending on which project your are working on:

$ bzr push lp:~yourusername/ubuntu-docs/branchname

$ bzr push lp:~yourusername/serverguide/branchname
  • "branchname" should be a short word which describes the branch.

Visit https://code.launchpad.net/~ and select the branch you just published. Click "Propose for Merging." You can leave the reviewer blank as the Ubuntu Documentation Committers will automatically be notified of your merge.

For more information about working with bzr, see the bzr website.

After you get used to Mallard, bzr and the DocumentationTeam, you are very likely to be offered an account so that you can write to the repository as well.

DocumentationTeam/SystemDocumentation/Submitting (last edited 2014-07-02 21:59:17 by knome)