annotate README @ 16:824c60f0d7b2

hgignore for the docs
author David A. Holland
date Mon, 03 Sep 2012 13:56:54 -0400
parents 5f96b693f41a
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
1
5f96b693f41a Preliminary project description.
David A. Holland
parents:
diff changeset
1 Welcome to swallowtail!
5f96b693f41a Preliminary project description.
David A. Holland
parents:
diff changeset
2
5f96b693f41a Preliminary project description.
David A. Holland
parents:
diff changeset
3 swallowtail is a bugtracking system meant to serve as a migration path
5f96b693f41a Preliminary project description.
David A. Holland
parents:
diff changeset
4 for large GNATS installations. It was designed with the following
5f96b693f41a Preliminary project description.
David A. Holland
parents:
diff changeset
5 assumptions:
5f96b693f41a Preliminary project description.
David A. Holland
parents:
diff changeset
6
5f96b693f41a Preliminary project description.
David A. Holland
parents:
diff changeset
7 - the database and its access tools are to be installed and
5f96b693f41a Preliminary project description.
David A. Holland
parents:
diff changeset
8 operating on a project server somewhere such that project
5f96b693f41a Preliminary project description.
David A. Holland
parents:
diff changeset
9 members have shell access and outsiders have web access;
5f96b693f41a Preliminary project description.
David A. Holland
parents:
diff changeset
10 - that project members do not need to be baby-sat;
5f96b693f41a Preliminary project description.
David A. Holland
parents:
diff changeset
11 - there is a large pre-existing bug database to be imported;
5f96b693f41a Preliminary project description.
David A. Holland
parents:
diff changeset
12 - the pre-existing database contains fields reflecting the
5f96b693f41a Preliminary project description.
David A. Holland
parents:
diff changeset
13 hardcoded GNATS data semantics;
5f96b693f41a Preliminary project description.
David A. Holland
parents:
diff changeset
14 - hand-editing any substantial fraction of the database is
5f96b693f41a Preliminary project description.
David A. Holland
parents:
diff changeset
15 impossible;
5f96b693f41a Preliminary project description.
David A. Holland
parents:
diff changeset
16 - incoming bug reports are submitted from a deployed base of
5f96b693f41a Preliminary project description.
David A. Holland
parents:
diff changeset
17 legacy GNATS send-pr scripts that can be superseded in the
5f96b693f41a Preliminary project description.
David A. Holland
parents:
diff changeset
18 wild only gradually;
5f96b693f41a Preliminary project description.
David A. Holland
parents:
diff changeset
19 - that there are relatively few preexisting database access
5f96b693f41a Preliminary project description.
David A. Holland
parents:
diff changeset
20 tools, such that replacing them all is readily feasible;
5f96b693f41a Preliminary project description.
David A. Holland
parents:
diff changeset
21 - enabling sql-based access to support new and custom tools is
5f96b693f41a Preliminary project description.
David A. Holland
parents:
diff changeset
22 more useful and of more interest than providing canned user
5f96b693f41a Preliminary project description.
David A. Holland
parents:
diff changeset
23 interface features;
5f96b693f41a Preliminary project description.
David A. Holland
parents:
diff changeset
24 - the database is too large for manual search, but not
5f96b693f41a Preliminary project description.
David A. Holland
parents:
diff changeset
25 necessarily too large for manual or manually-assisted
5f96b693f41a Preliminary project description.
David A. Holland
parents:
diff changeset
26 indexing;
5f96b693f41a Preliminary project description.
David A. Holland
parents:
diff changeset
27 - that multiple types of semantic indexing will be required,
5f96b693f41a Preliminary project description.
David A. Holland
parents:
diff changeset
28 and that tools should not have to treat each new index
5f96b693f41a Preliminary project description.
David A. Holland
parents:
diff changeset
29 scheme as a fresh special case.
5f96b693f41a Preliminary project description.
David A. Holland
parents:
diff changeset
30
5f96b693f41a Preliminary project description.
David A. Holland
parents:
diff changeset
31 It uses PostgreSQL for data storage. Other required software is as
5f96b693f41a Preliminary project description.
David A. Holland
parents:
diff changeset
32 follows:
5f96b693f41a Preliminary project description.
David A. Holland
parents:
diff changeset
33
5f96b693f41a Preliminary project description.
David A. Holland
parents:
diff changeset
34 [TBD]
5f96b693f41a Preliminary project description.
David A. Holland
parents:
diff changeset
35