Submitting

Differences between revisions 4 and 5
Revision 4 as of 2011-05-12 04:46:45
Size: 2607
Comment:
Revision 5 as of 2011-08-22 03:17:43
Size: 2605
Editor: jbicha
Comment: a little bit more about merging, removed duplicate contact info
Deletions are marked like this. Additions are marked like this.
Line 26: Line 26:
Another way it to publish them as a branch on Launchpad:{{{ Another way it to make a merge proposal using Launchpad:

{{{
Line 28: Line 30:
  "branchname" should be a short word which describes the branch. Usually your username will suffice.   "branchname" should be a short word which describes the branch.
Line 30: Line 32:
And to get the attention of the Committers you can email the [[DocumentationTeam/Contact|mailing list]], request a branch merge, or contact the team members in #ubuntu-doc on irc.freenode.net 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 34: Line 36:
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.

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.

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. There are a few ways to submit your changes for review, the first way is through the mailing list:

  1. If your change is a small one, the simplest way to publish it is to create a "bundle" and email it to the Documentation Team or attach it to a bug report:

    $ bzr bundle > diffname.txt
    • This creates the file diffname.txt, which contains the differences between the working copy and repository revisions of the modified files.

  2. You should send the patch/bundle to the team 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.

Another way it to make a merge proposal using Launchpad:

$ bzr push lp:~yourusername/ubuntu-docs/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)