db-derby-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Deepa Remesh (JIRA)" <derby-...@db.apache.org>
Subject [jira] Commented: (DERBY-379) Doc review: Getting Started with Derby
Date Mon, 27 Jun 2005 22:23:13 GMT
    [ http://issues.apache.org/jira/browse/DERBY-379?page=comments#action_12314556 ] 

Deepa Remesh commented on DERBY-379:
------------------------------------

The page numbers referred below are the PDF sheet numbers.

1) p. 6: "Installing Derby"
As mentioned in this section, when the Derby zip and tar files are extracted, they do not
get extracted to directory named apache-derby-10.0. Also, there is no subdirectory named lib.
The Derby jar files are not under lib directory. There are references to the lib directory
in many sections of the document (p.8: set CLASSPATH=%DERBY_INSTALL%\lib\derby.jar;%DERBY_INSTALL%\lib\derbytools.jar;%CLASSPATH%).
It would be good if the Derby zip or tar archive matches the description in the document or
vice versa. 

2) p. 10: "Database connection URL"
Since Derby provides two drivers, this statement is misleading "For the Derby-provided driver
listed in the previous section, the format for the database
connection URL for connecting to an existing database is this:". The database URL for the
Derby Network Client driver is not mentioned in this section.
It would be good if this section briefly describes the URLs for both the Derby drivers or
the above line can be changed to "For the Derby-provided embedded driver listed in the previous
section, ..."

3) p. 13: "Libraries provided by Derby"
The first column mentions only the names of the libraries and can be titled "Library name".





> Doc review:  Getting Started with Derby
> ---------------------------------------
>
>          Key: DERBY-379
>          URL: http://issues.apache.org/jira/browse/DERBY-379
>      Project: Derby
>         Type: Improvement
>   Components: Documentation
>  Environment: all
>     Reporter: Jeff Levitt
>     Priority: Minor
>      Fix For: 10.1.1.0

>
> This issue tracks comments for the Getting Started with Derby manual. The deadline for
posting comments isTuesday, June 28, noon Pacific time.
> Some guidelines to follow when posting comments to this issue are:
> - Try to make clear and concise comments about what you want changed whenever possible.
 Provide concrete comments that say "Please change <original> to <modified>" instead
of generic comments like "This section needs to be rewritten."
> - If you're reviewing the HTML Files copy, include the URL for the page in the review
comment. Obtain the URL like this:
>     * highlight the topic in the left frame
>     * right click
>     * choose "Properties"
>     * copy and paste the address in the pop up box.
> - If you're reviewing the PDF copy, in the review comment:
>     * Include the page number for the PDF, and indicate whether the number is the PDF
sheet number or the printed page number.
>     * Include the title of the section that the problem occurs in. If it's in a subsection,
try to include the hierarchy of titles.
> - Please don't review the HTML Book copy -- it'll be time consuming to match up that
copy with the underlying DITA source.

-- 
This message is automatically generated by JIRA.
-
If you think it was sent incorrectly contact one of the administrators:
   http://issues.apache.org/jira/secure/Administrators.jspa
-
For more information on JIRA, see:
   http://www.atlassian.com/software/jira


Mime
View raw message