DeveloperDocumentation

Revision 4 as of 2005-11-04 00:08:10

Clear message

Status

Summary

We should have well-organized developer-oriented documentation for our various tools and procedures, including freeze exceptions, merge-o-matic, seeds and their germination, and much, much more.

Interpretation and overall plan

During the first UBZ BOF, we concluded that the best way to achieve this would be to:

Create an Ubuntu Developers' Reference, which would be derived in the usual way (with a ubuntuNN version etc.) from the Debian Developers' Reference.

As well as deleting or replacing Debian-specific content from the DDR, we will transfer content from process-related wiki.ubuntu.com pages.

The Ubuntu Documentation Team will of course be consulted, but the UDR will be maintained primarily by Ubuntu developers since (a) much of the proposed (non-Debian) content is currently known only to Ubuntu developers and (b) the audience consists of Ubuntu developers.

Areas to cover (or consider covering)

  • BreezyReleaseSchedule (don't copy content, refer to it)

  • DeveloperResources (which should become a navigation page if not be completely deleted)

  • Different approaches to packaging, eg: debian/rules approaches (by-hand, debhelper, cdbs); patch systems (whether to use one, which one to use).

  • Who to talk to to decide whether to make a particular change/upload - areas of responsibility
  • Describe seeds and germination

BOF notes from Thursday

say at top which ubuntu release the doc describes the processes for

how to build package

  • - ubuntu-specific packages - ubuntu diffs from debian packages - syncs - package removals

When to make changes

  • - who to contact for advice / input / info about correct change to make
    • fine to make change covered by own area of responsibility for other things probably best to ask someone how to find out who last touched package compatibility problems / needed changes to other packages / communications
    - who to tell how after you've made your change / patch (what to do with patch) - who to ask before uploading (freezes, universe vs. main) - what to do after upload
    • - expect email - check build logs

How we handle translations

wiki/DeveloperResources becomes link list and referred to in document

chroots

patch systems etc.

how to handle bugs

  • (bug handling practices bof)

tools people might find helpful

  • pbuilder sudo lintian / linda piuparts

Who is responsible for various important subsystems

  • - kernel team, #ubuntu-kernel - docs team, #ubuntu-docs - universe packages, #ubuntu-motu
  • ..?

How to merge new Debian or new Upstream or external Repositories

  • merge-o-matic

How to import from Debian

backports

  • where to find them how to be nice to backporters who runs backports

When to not make changes

  • - freezes

how to get upload rights

  • main vs universe (ref) motu

wiki.ubuntu.com/REVU

get rid of

  • introdeveloperdocs (at least, not have it in main) (also is Ubuntu-native with wrong version)

registering gpg key

  • launchpad ?