~arsenal-devel/arsenal/apidoc

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
=== Hacking ===

If you've got ideas for improving the .html file contributions are easy:
Make a branch, add your changes with a good commit message, and propose
a merge.

Please try to do each change as a separate (tiny) commit.  That will
make it easier to keep this branch updated and to (hopefully) get the
changes integrated into trunk.

Also, avoid doing large reformatting changes, as those diffs will be
really hard to reconcile if/when we update.  Instead, do something like
a simple sed script that implements the change on top of the .html file.


=== Building ===

A `deploy` script is included, which does some postprocessing and then
publishes the .html to your people.canonical.com/~USERNAME page.  The
script assumes your p.c.c. username is the same as $USER; if that's not
the case, override it by specifying $PCC_USER.  I.e.:

me@machine$  PCC_USER=joeblow ./deploy


=== Tips ===

 * Locating the section in the .html file with an editor can be hard
   since the .html file is so long.  Try searching it by id="NAME" where
   NAME is the name of whatever object you're looking for (usually in
   lowercase).

 * Launchpad typically generates the Description as a concatenation of
   two internal fields 'title' and 'description'.  This is why you
   sometimes see just the name of the field repeated in the Description
   column.  So the ideal form for Descriptions would be:

    My Foo Title
    This is a blah blah description of Foo, blah blah.