Mailing-List: contact derby-dev-help@db.apache.org; run by ezmlm
Precedence: bulk
Reply-To: <derby-dev@db.apache.org>
Received-SPF: pass (asf.osuosl.org: domain of scotsmatrix@gmail.com designates
 66.249.92.169 as permitted sender)
DomainKey-Signature: a=rsa-sha1; q=dns; c=nofws;
        s=beta; d=gmail.com;
        h=received:message-id:date:from:to:subject:in-reply-to:mime-version:content-type:content-transfer-encoding:content-disposition:references;
        b=HKKhg7GFK11zr9Ye3/cKLjf8CJFcm8sot2PaQPc8YK8BP47etnVKyWe1TYqdjsMdiGFNs233nfZnkJ0t5/7WwtsD/Bxy9ArUIlISYEqG8/FHHWyvhCY+O7lxR4ftNywVtsLrvM8Kuyee5jKQNCNo11mqyjnJCW4T18ag7Gqh9Vo=
Message-ID: <9f40b500608160845k7ff6a1e0q5383ba5c7e37a035@mail.gmail.com>
Date: Wed, 16 Aug 2006 08:45:06 -0700
From: "Laura Stewart" <scotsmatrix@gmail.com>
To: derby-dev@db.apache.org
Subject: Re: 10.2 documentation reviews
In-Reply-To: <44E337CA.3070803@gmail.com>
MIME-Version: 1.0
Content-Type: text/plain; charset=ISO-8859-1; format=flowed
Content-Transfer-Encoding: 7bit
Content-Disposition: inline
References: <9f40b500608151557h5caf600bk27706be3608e2982@mail.gmail.com>
	 <44E29334.20702@bristowhill.com> <44E293F6.90908@apache.org>
	 <44E29481.9070009@bristowhill.com> <44E29645.1010000@apache.org>
	 <44E2BBB8.4070608@gmail.com> <44E3348D.2070406@bristowhill.com>
	 <44E337CA.3070803@gmail.com>

As one of the people who is interested in implementing the comments
that are made on the documentation, I would like to see the following
:

1. Tables for each book on the wiki pages that Jean created. The
columns should be: Section name, Page, Comment, Status
where
Section name = the name of section in the book that you are making a
comment on.
Page = the page number (PDF or printed) that your comment refers to.
Comment = Short comments should be entered here using the guidelines
on the main TenTwo Documentation page:
http://wiki.apache.org/db-derby/TenTwoDocReview
Longer comments should not be entered into the table. Instead a Jira
issue should be created with DOCS as the first word in the title, and
the number (link) for the Jira issue entered into the table.
Status = This column is used by people updating the documentation to
indicate when the comment is incorporated into 10.2.

2. The suggestion to divide the books up by chapter/section for the
reviews is a good one.  This will give the docs a more global review
than just re-reviewing the information added in 10.2.  With this
approach it is very likely that someone will run across a section that
should have been updated for 10.2 and was missed. It will also find
sections that need to be improved.

-- 
Laura Stewart