db-derby-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Kristian Waagan (Commented) (JIRA)" <j...@apache.org>
Subject [jira] [Commented] (DERBY-5464) Add easier to find links to Derby JavaDoc on the Derby web site
Date Fri, 14 Oct 2011 20:36:13 GMT

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

Kristian Waagan commented on DERBY-5464:
----------------------------------------

Thanks, Kim.

I'll address the trademark issue in the next revision of the patch, which will also include
other required changes.

Regarding the links to the different parts of the API documentation:
 o The public API is already linked to for each version of Derby on the documentation page.
 o The Apache Derby Papers page probably doesn't include testing because it's all about the
engine (I'm just guessing here). Not sure if Tools fits into that theory though...

Regarding the documentation page, we can (a) use "API documentation" and duplicate the link
to the published API, or (b) use "Internal API documentation" with the engine, language, testing,
and tools links.
I lean towards (b) - i.e. a kind of Derby user vs Derby developer distinction [1] - but can
happily go with (a) too :)

Of course, the content can be organized in a totally different way too. For instance, we could
add the links into the latest alpha docs table. My reason for not doing that, is that I doubt
these links will be used much by Derby users.


[1] Tools may not fit here, but then again BNF isn't the most user friendly documentation
in my opinion... At least this one has comments and some helpful text :)
                
> Add easier to find links to Derby JavaDoc on the Derby web site
> ---------------------------------------------------------------
>
>                 Key: DERBY-5464
>                 URL: https://issues.apache.org/jira/browse/DERBY-5464
>             Project: Derby
>          Issue Type: Task
>          Components: Web Site
>    Affects Versions: 10.9.0.0
>            Reporter: Kristian Waagan
>            Assignee: Kristian Waagan
>            Priority: Minor
>         Attachments: derby-5464-javadoc_links.diff, index-1a.html
>
>
> Add links to the Derby JavaDocs, which we do publish on the Derby web site.
> They can currently be found under Resources -> Papers -> Engine -> JavaDoc,
but I'm proposing we add links to them under Documentation.

--
This message is automatically generated by JIRA.
If you think it was sent incorrectly, please contact your JIRA administrators: https://issues.apache.org/jira/secure/ContactAdministrators!default.jspa
For more information on JIRA, see: http://www.atlassian.com/software/jira

        

Mime
View raw message