Mailing-List: contact derby-dev-help@db.apache.org; run by ezmlm
Precedence: bulk
Reply-To: <derby-dev@db.apache.org>
Message-ID: <674929803.1219437526188.JavaMail.jira@brutus>
Date: Fri, 22 Aug 2008 13:38:46 -0700 (PDT)
From: "Kim Haase (JIRA)" <jira@apache.org>
To: derby-dev@db.apache.org
Subject: [jira] Commented: (DERBY-2389) DOCS - Move Derby system and
 properties info from Tuning Guide into Reference Manual
In-Reply-To: <29510837.1172775230664.JavaMail.jira@brutus>
MIME-Version: 1.0
Content-Type: text/plain; charset=utf-8
Content-Transfer-Encoding: 7bit


    [ https://issues.apache.org/jira/browse/DERBY-2389?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=12624975#action_12624975 ] 

Kim Haase commented on DERBY-2389:
----------------------------------

I think it's time to get to work on this job.

Moving these topics to the Reference Manual would have some drawbacks: it might confuse readers who are used to going to the Tuning Guide for this information, and it would make the largest manual even bigger.

It would also be somewhat tedious and error-prone to move and rename the topics and to fix all the references to them in the Tuning Guide and other manuals. I'm happy to do it, though.

There are relatively few direct cross-references to the property topics in the Tuning Guide itself -- only about 8 that are not from other property topics. There may actually be more opportunities for direct cross-references in the Reference Manual.

> DOCS - Move Derby system and properties info from Tuning Guide into Reference Manual
> ------------------------------------------------------------------------------------
>
>                 Key: DERBY-2389
>                 URL: https://issues.apache.org/jira/browse/DERBY-2389
>             Project: Derby
>          Issue Type: Improvement
>          Components: Documentation
>            Reporter: Laura Stewart
>            Assignee: Kim Haase
>
> From Derby User list:
> On 2/21/07, Anders Morken <andersmo@stud.ntnu.no> wrote:
> > Shooting from the hip here, but one thing that has occured to me a few
> > times as I've browsed the docs to figure something out is that I
> > intuitively expect Derby system and database properties (especially the
> > non-performance-related) to be documented in the reference guide, not
> > the tuning guide. =)
> On 2/21/07, Oystein Grovlen - Sun Norway <Oystein.Grovlen@sun.com> wrote:
> > I agree on this.  I would have preferred that all "facts" where
> > presented in the Reference Manual, and that the other manuals where more
> > "pedagogical" presentations of the same material.  Currently, it is not
> > very intuitive to determine which manual has the information you are
> > looking for.

-- 
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.