[
https://issues.apache.org/jira/browse/DERBY-2390?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel#action_12503782
]
John H. Embretsen commented on DERBY-2390:
------------------------------------------
While browsing the merged document (getstartderby.pdf) I noticed a couple of
issues not directly related to this work, but that are present in each of the
manuals that are part of this merger. I see a number of different ways to
handle this, but I'm not sure which one is the best:
a) Fix the issues as part of this JIRA-issue
b) Create two new JIRA-issues, one for each of the current manuals ("Getting
Started" and "Working with Derby")
c) Wait until the two manuals have been merged and then create a new
JIRA-issue for fixing the issues.
I tend to think that option c) is the cleanest way to go, but let me know if
anyone has other ideas.
The issues are potentially factual errors in the manuals, but this may be
subject to discussion. I do not consider it important to fix these issues by
the time a release candidate for 10.3 is generated (we may not have enough time
for that anyway). Issues are:
1) Getting Started with Derby: Installing Derby: Confusing description of the
bin-distribution, seems to say that jar files are not part it.
2) Working With Derby: Activity 3: The WwdEmbedded program:
a) The "Shut down the database" shuts down the engine, not an
individual database. It should make a point about the difference between these
operations.
b) The same section says that "The XJ015 error is the only exception
thrown by Derby that indicates that an operation succeeded. All other
exceptions indicate that an operation failed." What about '08006 - Database
'<databaseName>' shutdown'?
I found no issues with the merger itself that was not already commented by
others - but I'll consider reading an updated version if I have enough cycles
available when it is submitted.
> DOCS - Merge Working with Derby and Getting Started Guide
> ---------------------------------------------------------
>
> Key: DERBY-2390
> URL: https://issues.apache.org/jira/browse/DERBY-2390
> Project: Derby
> Issue Type: Improvement
> Components: Documentation
> Reporter: Laura Stewart
> Assignee: Laura Stewart
> Fix For: 10.3.0.0
>
> Attachments: cgsintro.html, getstartderby.pdf, rgsdocs17307.html
>
>
> The activities in the Working with Derby guide should be merged into the
> Getting Started Guide.
> Review Getting Started Guide for any reference info that should be either
> "shared" with another guide
> or moved to another guide. For example, the SQL Syntax section in the Getting
> Started Guide should
> be moved to the Reference Manual.
--
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.
