You are viewing a plain text version of this content. The canonical link for it is here.
Posted to derby-dev@db.apache.org by "Kim Haase (JIRA)" <ji...@apache.org> on 2014/06/02 19:10:02 UTC

[jira] [Comment Edited] (DERBY-6217) Put all of the security documentation in a single, separate user guide

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

Kim Haase edited comment on DERBY-6217 at 6/2/14 5:09 PM:
----------------------------------------------------------

Uploading DERBY-6217-fixptrs1.diff, DERBY-6217-fixptrs1.stat, and DERBY-6217-fixptrs1.zip, the first of two patches to fix the pointers in the manuals that referred to the security topics in the Admin Guide and Developer's Guide so that they point to the equivalent topics in the Security Guide. This patch involves 4 topics in the Tools Guide, 2 topics in Getting Started (including the doc list), and 76 topics in the Reference Manual.

None of these are actual xref elements, since they point to other manuals. The next patch will include the changes to the Developer's Guide and Admin Guide themselves, so some of them will be xrefs. This patch will also remove the obsolete topics in those two manuals.

I plan to commit this patch tomorrow, unless someone actually has the capacity for boredom to review this and needs more time.


was (Author: chaase3):
Uploading DERBY-6217-fixptrs1.diff, DERBY-6217-fixptrs1.stat, and DERBY-6217-fixptrs1.zip, the first of two patches to fix the pointers in the manuals that referred to the security topics in the Admin Guide and Developer's Guide so that they point to the equivalent topics in the Security Guide. This patch involves 4 topics in the Tools Guide, 2 topics in Getting Started (including the doc list), and 76 topics in the Reference Manual.

None of these are actual xref elements, since they point to other manuals. The next patch will include the changes to the Developer's Guide and Admin Guide themselves, so some of them will be xrefs. The last step will be a patch that removes the obsolete topics.

I plan to commit this patch tomorrow, unless someone actually has the capacity for boredom to review this and needs more time.

> Put all of the security documentation in a single, separate user guide
> ----------------------------------------------------------------------
>
>                 Key: DERBY-6217
>                 URL: https://issues.apache.org/jira/browse/DERBY-6217
>             Project: Derby
>          Issue Type: Improvement
>          Components: Documentation
>    Affects Versions: 10.11.0.0
>            Reporter: Rick Hillegas
>            Assignee: Kim Haase
>         Attachments: DERBY-6217-2.diff, DERBY-6217-3.diff, DERBY-6217-fixptrs1.diff, DERBY-6217-fixptrs1.stat, DERBY-6217-fixptrs1.zip, DERBY-6217.diff, DERBY-6217.stat, DERBY-6217.zip
>
>
> Right now the security documentation is divided among our user guides. This makes is hard for customers to understand Derby's defenses and how to configure all relevant security mechanisms for an application. As demonstrated by the discussion on DERBY-6160, some security mechanisms involve multiple Derby jar files and multiple application tiers. Material for these mechanisms is scattered across the existing user guides. It would be less confusing if all of Derby's security documentation were separated out into a new Security Guide.



--
This message was sent by Atlassian JIRA
(v6.2#6252)