db-derby-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Jeff Levitt (JIRA)" <derby-...@db.apache.org>
Subject [jira] Updated: (DERBY-379) Doc review (CLOSED TO FURTHER COMMENTS): Getting Started with Derby
Date Wed, 29 Jun 2005 07:43:58 GMT
     [ http://issues.apache.org/jira/browse/DERBY-379?page=all ]

Jeff Levitt updated DERBY-379:

    Attachment: derby379.diff

The attached patch makes the changes requested in this doc review.  I have created sample
output on my own site:

HTML files:  http://derby.mylevita.com/getstart/
PDF:  http://derby.mylevita.com/getstart/getstartderby.pdf

A couple of items to note:

The patch affects EVERY dita file, but not the content for each file.  This is because I modified
the year in the dita source file copyrights for each file from "2004" to "2005".  So while
every file is listed in the patch, the only changes that will appear in the PDF and HTML files
are those requested in this doc review.

I also made some changes to the trademarks page (The last section in the manual).  This page
listed trademarks for other companies.  While the Microsoft, Sun, and Open Group trademarks
appeared normal, the IBM tradmarks were in a table that was not appearing.  It didn't make
sense to be placing the IBM trademarks in a table while the other companies were not, so I
deleted the table and rewrote the IBM trademarks in a sentence just like the others.  Please
(you can compare it to our existing page: http://incubator.apache.org/derby/docs/getstart/rgstrademderby.html
While the table currently shows up fine in that HTML link, it does not appear in the current

This page appears the same in all 6 books, so I would also apply this change to the docs in
each of their respective doc review patches.  I think this section needs to be carefully reviewed
with the rest of the changes made in this patch, as this is legal information concerning multiple
companies and should not be taken lightly.

> Doc review (CLOSED TO FURTHER COMMENTS):  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:
>  Attachments: derby379.diff
> This issue tracks comments for the Getting Started with Derby manual. The deadline for
posting comments was Tuesday, June 28, noon Pacific time.
please open a JIRA issue for a fixin in a future release, as there is not enough time to incorporate
additional comments.
> 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:
For more information on JIRA, see:

View raw message