db-derby-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Kim Haase (JIRA)" <j...@apache.org>
Subject [jira] Commented: (DERBY-2389) DOCS - Move Derby system and properties info from Tuning Guide into Reference Manual
Date Thu, 20 Nov 2008 15:20:44 GMT

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

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

I've been thinking about the "Working with Derby properties" topics in Tuning Derby and whether
they still belong there.

There are NO cross-references to these topics elsewhere in Tuning Derby, which suggests that
the content really doesn't have much to do with tuning.

There is one such cross-reference in the Admin Guide.

There are six in the Developer's Guide, which suggests that the content might belong there,
as Dag was thinking. Three are in the "Derby and Security" topics and the other three are
in "JDBC applications and Derby basics."

The question then arises where in the Developer's Guide to put the topics. Here are some possibilities.

 - as a third subsection of "JDBC applications and Derby basics," after "Derby embedded basics"
 - as another subsection of "Controlling Derby application behavior", which contains some
other "Working with ..." subsections
 - as another top-level topic, maybe after "JDBC applications and Derby basics"

I'm leaning toward the first -- would anyone like to weigh in on this?

(BTW, that section "After installing" should probably be nearer to the beginning of the book,
shouldn't it? Maybe right after the Upgrades section? That's a separate issue, though.)


> 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
>    Affects Versions: 10.4.2.0
>            Reporter: Laura Stewart
>            Assignee: Kim Haase
>         Attachments: DERBY-2389-adminguide.diff, DERBY-2389-adminguide.stat, DERBY-2389-adminguide.zip,
DERBY-2389-devguide.diff, DERBY-2389-devguide.stat, DERBY-2389-devguide.zip, DERBY-2389-getstart.diff,
DERBY-2389-getstart.stat, DERBY-2389-getstart.zip, DERBY-2389-ref.diff, DERBY-2389-ref.stat,
DERBY-2389-ref.zip, DERBY-2389-ref2.zip, DERBY-2389-tuning.diff, DERBY-2389-tuning.stat, DERBY-2389-tuning.zip
>
>
> 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.


Mime
View raw message