Contributing

Debian Women - Website

This page will try to give an overview and starting pointers for anyone who would like to contribute to the Debian Women website.

If you want a more thorough introduction to Arch, please read the short HOWTO here.

Note that in the examples below, the text has sometimes been wrapped to the next line. While it is perfectly valid to type the text as-is, it also works when typed on a single line. The wrapping is only for layout purposes.

Obtaining the source

In order to contribute to the website, you need to checkout the source code first. The source code for the Debian Women website is in an Arch archive on the Alioth project space. You should register the archive with the following command:

$ baz register-archive \
> women-website@lists.alioth.debian.org \
> sftp://username@arch.debian.org/arch/women/website

Thanks to Clint Adams for helping to set this up on arch.debian.org.

You should also make the archive your default, by running:

$ baz my-default-archive \
> women-website@lists.alioth.debian.org

Note that currently, in order to contribute, you must be part of the Debian Women project. If you are not, you can contact Erinn Clark.

Next, you should change to a directory in which you want to create the sub-directory for the working copy (e.g. ~/src) and run the following command:

$ baz get website--trunk--0.1 website

This will retrieve the latest version of the source code into a sub-directory called website. You can now start by exploring that directory and add or modify things as you see fit.

Arch uses some special directories, names .arch-ids and {arch}, which you can safely ignore for the time being.

Synchronizing changes made by others

Since most likely there will be several people working on the website, it is always a good idea to update your working copy to the latest version by running:

$ baz update

from inside the root of your working copy.

Committing changes

After you've made your changes, you can review them with:

$ baz status

and

$ baz diff

After checking that everything is correct, you can permanently commit these changes by running:

$ baz commit

to commit your changes. In case you have not created a log yet, baz will create one for you and popup your favorite editor.

Where to go from here

The following documents will go into further details about how the site is structured, and how to use special WML tags to format the pages:

  • The File hierarchy document explains the hierarchy of the website, where to find which files, etc.
  • The WML tags document explains which WML tags you can use to markup text.