Repository

Differences between revisions 10 and 11
Revision 10 as of 2009-04-29 22:34:06
Size: 6191
Editor: 89-168-96-191
Comment: add some examples for getting branches
Revision 11 as of 2009-04-29 22:37:27
Size: 5547
Editor: 89-168-96-191
Comment: removing lightweight checkouts because these now take longer than a normal checkout
Deletions are marked like this. Additions are marked like this.
Line 27: Line 27:
== Checking-out the docs == == Getting the docs ==
Line 44: Line 44:
There are several ways to improve the speed of downloading branches.

 1. If you wish to check out more than one branch, it is more efficient
to store the revision history for the branches in a ''shared repository'', because the revision history for all of the branches shares a lot of data. To set up a shared repository, create a folder (e.g. "ubuntu-bzr") which you wish to use to store all the branches in as follows:{{{
If you are getting more than one branch, it can improve the speed of the download to store the revision history for the branches in a ''shared repository'', because the revision history for all of the branches shares a lot of data. To set up a shared repository, create a folder (e.g. "ubuntu-bzr") which you wish to use to store all the branches in as follows:{{{
Line 48: Line 46:
 1. Lightweight checkouts. You can avoid downloading the full revision history for a branch using a lightweight checkout:{{{
$ bzr checkout --lightweight http://address/to/branch name_of_branch}}} Note: significant improvements in Bazaar branching has resulted in lightweight checkouts taking as much, or more, time than branching. Please see [[https://bugs.edge.launchpad.net/bzr/+bug/368717|Bug #368717]] for more information. For more information about lightweight checkouts, please read the [[http://bazaar-vcs.org/CheckoutTutorial|Bazaar Checkout Tutorial]].
Line 53: Line 49:
You will probably want to keep up-to-date with changes made to the documentation. To download the latest updates to ''ubuntu-changes'': You will probably want to keep up-to-date with changes made to the documentation. To download the latest updates to a branch:

About The Repository

The documentation sources for the project reside in Bazaar, a revision management system created by Canonical, the company behind Ubuntu. The repository is the hub of the core document development effort. Revision control helps us to work on the same files simultaneously without “clobbering” each others work. Any author wanting to contribute to the documentation effort can checkout their own branch or working copy of the documentation sources and make changes to this copy.

If you have never worked with a version control system, don't be nervous - you cannot break anything in the repository, only your local, working copy. This is because you will be working as an anonymous user and therefore do not have the permissions to change anything in the repository. Only people with commit access can make changes to the repository. People are given access once they have consistently provided contributions and demonstrated commitment.

A list of Doc Team Bazaar branches is available on Launchpad.

Installing Bazaar

In order to use Bazaar, install the bzr package.

Once installed, type bzr whoami 'Your Name <you@example.com>' in a Terminal to identify yourself to bzr. You might also need to change the bazaar plugin that manages launchpad login to match your launchpad username. bzr launchpad-login <launchpad user name> should change this.

Generating SSH keys

If you are using bazaar over ssh, you might also need to generate ssh keys and add it to Launchpad.

  1. Type ssh-keygen -t rsa to generate a ssh key. If you already have generated ssh keys, feel free to ignore this step.

  2. Visit https://launchpad.net/~<your launchpad username>/+editsshkeys and update your ssh keys.

Getting the docs

To make changes to documentation held in a Bazaar branch, you first need to download a copy onto your computer.

  1. Open a Terminal by pressing Applications -> Accessories -> Terminal.

  2. Type mkdir ubuntu_bzr and press enter. This will create a new directory called ubuntu_bzr in your Home directory. Of course, you can create a directory with a different name and in a different location.

  3. Type cd ubuntu_bzr to change to the new directory.

  4. Type bzr branch http://address/to/branch name_of_branch into the Terminal. This will download the whole of the branch, which you will then be able to modify using a text editor.

    • You can get the name of the branch which you want from the list on Launchpad

    • For example, if you would like to download the Kubuntu docs for the "Karmic Koala" release, you can see from the list that the required branch is lp:~ubuntu-core-doc/ubuntu-doc/kubuntu-karmic. So, to get that branch, you would type:

      $ bzr branch lp:~ubuntu-core-doc/ubuntu-doc/kubuntu-karmic
    • Using a "lp" shortcut in this way will use the SSH protocol to download the files. If you cannot use SSH for some reason, you can replace the "lp" shortcut with the full http URL of the branch. So to get the Kubuntu docs for "Karmic Koala", you would type:

      $ bzr branch https://code.launchpad.net/~ubuntu-core-doc/ubuntu-doc/kubuntu-karmic
    • This process may take quite a while, as it downloads the whole of the revision history in the branch. See Advanced below for ways to speed up this process.

Advanced

If you are getting more than one branch, it can improve the speed of the download to store the revision history for the branches in a shared repository, because the revision history for all of the branches shares a lot of data. To set up a shared repository, create a folder (e.g. "ubuntu-bzr") which you wish to use to store all the branches in as follows:

$ bzr init-repo --trees --format=dirstate-with-subtree ubuntu-bzr

You can then create branches within this subfolder using the process described in the previous section and they will share their revision history in the shared repository you have created.

Updating a check-out

You will probably want to keep up-to-date with changes made to the documentation. To download the latest updates to a branch:

  1. Open a Terminal.
  2. Change to the directory which contains your original checkout (e.g. ubuntu_bzr/name_of_branch, as above).
  3. Type bzr merge and any updates will be downloaded.

Additional information

See the Bazaar Documentation website for comprehensive documentation. There is also a useful quick-start guide.

Next steps

Once you have downloaded a branch, the next step is to view and edit the documents contained within it. Read on to the Editing page.

Some tips for people who have been granted permissions to upload directly to the system documentation branches (by becoming members of the ubuntu-core-doc team) can be found at the /Members page. If you are just getting started with Ubuntu documentation, you don't need to read that page yet.


CategoryDocteam

DocumentationTeam/SystemDocumentation/Repository (last edited 2014-07-02 21:05:36 by belkinsa)