Repository
|
Size: 5984
Comment: removing sections only relevant to docteam members
|
Size: 3092
Comment: fix another dead link
|
| Deletions are marked like this. | Additions are marked like this. |
| Line 1: | Line 1: |
| <<Include(DocumentationTeam/MenuBar)>> | #title The System Documentation Repository <<Include(DocumentationTeam/SystemDocumentation/MenuBar)>> |
| Line 11: | Line 13: |
| A list of Doc Team Bazaar branches is available on [[https://code.launchpad.net/ubuntu-doc|Launchpad]]. | == Key Bzr Branches == |
| Line 13: | Line 15: |
| == Installing Bazaar == | A complete list of the key Doc Team Bazaar branches is available on [[https://code.launchpad.net/~ubuntu-core-doc|Launchpad]]. |
| Line 15: | Line 17: |
| In order to use Bazaar, install the {{{bzr}}} package. | The key branches which will be of most interest are: |
| Line 17: | Line 19: |
| 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. | ||<tablestyle="border:1px solid"> '''Name of Branch''' || '''Description''' || || [[https://code.launchpad.net/~ubuntu-core-doc/ubuntu-docs|ubuntu-docs]] || Ubuntu desktop help || || [[https://code.launchpad.net/~ubuntu-core-doc/xubuntu-docs|xubuntu-docs]] || Xubuntu desktop help || || [[https://code.launchpad.net/~ubuntu-core-doc/serverguide|serverguide]] || Ubuntu Server Guide || |
| Line 19: | Line 24: |
| == Generating SSH keys == If you are using bazaar over ssh, you might also need to generate ssh keys and add it to launchpad, and add a ~/.ssh/config to allow you to connect to launchpad with a different user name than your Ubuntu Linux account. |
Generally you should use the development version for each branch. |
| Line 22: | Line 26: |
| 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. 3. Add/Edit ~/.ssh/config to contain the following {{{ Host *launchpad.net User <your launchpad username>}}} == Checking-out the docs == To make changes to documentation held in a Bazaar branch, you first need to download a copy onto your computer. These instructions cover downloading the ''ubuntu-changes'' branch of the gnome-user-docs. 1. Open a Terminal by pressing '''Applications''' -> '''Accessories''' -> '''Terminal'''. 1. 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. 1. Type {{{cd ubuntu_bzr}}} to change to the new directory. 1. Type {{{bzr branch http://address/to/branch name_of_branch}}} into the Terminal (choose the branch which you want to download from the [[https://code.launchpad.net/ubuntu-doc|list on Launchpad]]). This will download the whole of the branch, which you will then be able to modify using a text editor. 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 === 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:{{{ $ 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. 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}}} For more information see the [http://bazaar-vcs.org/CheckoutTutorial bzr website]. 1. Downloading a tarball of the revision history. To improve download speed, you can download a compressed tarball which you can use to create a shared repository with the revision history for all the branches. The tarball can be downloaded [[http://calcium.ubuntu.com/~mdke/ubuntu-doc-initial.tar.bz2|here]] and is currently 420MB (a saving of 200MB or so on the full shared repository). After downloading the tarball, extract the contents into the folder you wish to use for a shared repository. You will then have full revision history for all the branches. To get a updated working tree for any branch, simply run:{{{ $ cd name_of_branch $ bzr checkout . $ bzr update}}} == 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 ''ubuntu-changes'': 1. Open a Terminal. 1. Change to the directory which contains your original checkout (e.g. ubuntu_bzr/name_of_branch, as above). 1. Type {{{bzr merge}}} and any updates will be downloaded. == See a list of changed files == To see a list of all of the files which you have changed in the current directory, type the following: {{{bzr diff | grep ===}}} == Command summary == To see a simple one line reminder for each of the commands outlined here, type the following in Terminal: {{{bzr help}}} |
For details on setting up and contributing, please refer to either the [[https://wiki.ubuntu.com/DocumentationTeam/SystemDocumentation/UbuntuDesktopGuide|Ubuntu Desktop Guide Single Page]] or the [[https://wiki.ubuntu.com/DocumentationTeam/SystemDocumentation/UbuntuServerGuide|Ubuntu ServerGuide Single Page]] as appropriate. (xubuntu ?) |
| Line 73: | Line 30: |
| See the [[http://bazaar-vcs.org/Documentation|Bazaar Documentation website]] for comprehensive documentation. There is also a useful [[http://bazaar-vcs.org/QuickHackingWithBzr|quick-start guide]]. | See the [[http://wiki.bazaar.canonical.com/Documentation|Bazaar Documentation website]] for comprehensive documentation. There is also a useful [[http://doc.bazaar.canonical.com/bzr.dev/en/mini-tutorial/index.html|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 '''[[DocumentationTeam/SystemDocumentation/Editing|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. |
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.
Key Bzr Branches
A complete list of the key Doc Team Bazaar branches is available on Launchpad.
The key branches which will be of most interest are:
Name of Branch |
Description |
Ubuntu desktop help |
|
Xubuntu desktop help |
|
Ubuntu Server Guide |
Generally you should use the development version for each branch.
For details on setting up and contributing, please refer to either the Ubuntu Desktop Guide Single Page or the Ubuntu ServerGuide Single Page as appropriate. (xubuntu ?)
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.
DocumentationTeam/SystemDocumentation/Repository (last edited 2014-07-02 21:05:36 by belkinsa)