db-derby-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Kim Haase (JIRA)" <j...@apache.org>
Subject [jira] [Commented] (DERBY-6065) LockTable API link in the documentation is broken
Date Mon, 04 Feb 2013 15:14:12 GMT

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

Kim Haase commented on DERBY-6065:
----------------------------------

The link to the javadoc was put in as part of the fix to DERBY-2845 several years ago. 

The links at the bottom of the Derby documentation page now point to the latest builds of
the javadoc rather than the "dev" directory. So the LockTable javadoc is under

https://builds.apache.org/job/Derby-trunk/lastSuccessfulBuild/artifact/trunk/javadoc/engine/index.html

So this link will work:

https://builds.apache.org/job/Derby-trunk/lastSuccessfulBuild/artifact/trunk/javadoc/engine/org/apache/derby/diag/LockTable.html

These links are likely to keep working if we want to use them, aren't they? In theory we could
either link directly to the LockTable page or say "See the documentation for org.apache.derby.diag.LockTable
under https://builds.apache.org/job/Derby-trunk/lastSuccessfulBuild/artifact/trunk/javadoc/engine/index.html".

There are some similarly broken links elsewhere -- the JMX documentation in the Admin Guide
points to "http://db.apache.org/derby/javadoc/publishedapi/jdbc4/", which no longer works,
though it must have worked a year ago. We can't point directly to release-specific API docs
from the other documentation, since the link is quite different in the development docs versus
the released docs.

It is probably a lot safer to do what we generally do in the Reference Manual, to say something
like "For more information, see the public API javadoc for org.apache.derby.catalog.SequencePreallocator."

Maybe we should generalize this issue to "Direct API links in the documentation are broken"
so we can fix both the Dev Guide link and the Admin Guide ones. Anyone can fix the wiki links
as they see fit, I think.
                
> 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

Mime
View raw message