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

Rick Hillegas commented on DERBY-6065:
--------------------------------------

I'm puzzled by this problem. When a user guide links to javadoc, it should 
point at the javadoc for a specific release, namely, the rev level of the user 
guide. Pointing to the trunk javadoc seems wrong to me. Pointing to the latest 
release's javadoc seems wrong too.

It's possible that the move to svnpubsub broke this, but I don't understand 
how. I looked at the pre-svnpubsub docs on people.apache.org at 
/www/db.apache.org/content/derby/docs. Next to each release's docs, I see a 
directory of publishedapi. But that's just the public api javadoc, not the full 
engine javadoc. So the release-specific javadoc for LockTable has never been 
included with our release docs. I don't understand how this link ever worked.

Possible solutions include:

o Publishing the full engine javadoc with each release.

o Adding LockTable's javadoc to our public api.

o Including LockTable's javadoc in the user guide.

                
> LockTable API link in the documentation is broken
> -------------------------------------------------
>
>                 Key: DERBY-6065
>                 URL: https://issues.apache.org/jira/browse/DERBY-6065
>             Project: Derby
>          Issue Type: Bug
>          Components: Documentation
>    Affects Versions: 10.9.1.0
>            Reporter: Bryan Pendleton
>            Priority: Minor
>
> I happened to notice that some of the links in the documentation are broken.
> For example, on 
> http://db.apache.org/derby/docs/10.9/devguide/cdevconcepts50894.html
> the link to LockTable API documentation is broken.
> There are also broken links to the documentation in the wiki, but that's not 
> something we track with JIRA issues, I think. But it would be nice to figure 
> out if we can clean up those links easily. For example, on  
> http://wiki.apache.org/db-derby/LockDebugging there are broken links to the 
> LockTable API documentation, as well as to the SYSCS_DIAG table documentation.

--
This message is automatically generated by JIRA.
If you think it was sent incorrectly, please contact your JIRA administrators
For more information on JIRA, see: http://www.atlassian.com/software/jira

Reply via email to