lucene-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Mark Miller (JIRA)" <j...@apache.org>
Subject [jira] Issue Comment Edited: (LUCENE-1897) Links to javadoc from the site pages do not work in the src dist because it does not include the javadoc under docs.
Date Sat, 12 Sep 2009 05:06:57 GMT

    [ https://issues.apache.org/jira/browse/LUCENE-1897?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=12754480#action_12754480
] 

Mark Miller edited comment on LUCENE-1897 at 9/11/09 10:05 PM:
---------------------------------------------------------------

I guess.

bq. if we had a refrence to a jar file in a README or an html page we wouldn't consider it
a bug that people couldn't find that jar file in a source release

I dunno - perhaps. If the README said, you will find this jar at /lucene/jar and then I go
to /lucene/jar and nothing is there, I would personally find that a bit confusing. But it
wouldnt bother me too much I guess.

But if I open the site HTML in the folder docs, and most of the links are broken cause they
point to javadoc - that seems broken to me. Whether we want to fix it or not, I don't know
and I don't have a real suggestion - but certainly seems like a bug when we distribute a bunch
of docs in a doc folder with a bunch of broken links.

* edit *

Unless it says somewhere - by the way - the doc folder will contain a bunch of broken links
until you build the javadocs - that would convince me otherwise.

I'm not super concerned either way - you can feel free to close - it was more to flag a discussion
than anything I'm personally vested in. To me, downloading to view the source, and then looking
through the docs, I'd be confused when the links didn't work - but that doesn't mean anything
has to change.


      was (Author: markrmiller@gmail.com):
    I guess.

bq. if we had a refrence to a jar file in a README or an html page we wouldn't consider it
a bug that people couldn't find that jar file in a source release

I dunno - perhaps. If the README said, you will find this jar at /lucene/jar and then I go
to /lucene/jar and nothing is there, I would personally find that a bit confusing. But it
wouldnt bother me too much I guess.

But if I open the site HTML in the folder docs, and most of the links are broken cause they
point to javadoc - that seems broken to me. Whether we want to fix it or not, I don't know
and I don't have a real suggestion - but certainly seems like a bug when we distribute a bunch
of docs in a doc folder with a bunch of broken links.

* edit *

Unless it says somewhere - by the way - the doc folder will contain a bunch of links until
you build the javadocs - that would convince me otherwise.

I'm not super concerned either way - you can feel free to close - it was more to flag a discussion
than anything I'm personally vested in. To me, downloading to view the source, and then looking
through the docs, I'd be confused when the links didn't work - but that doesn't mean anything
has to change.

  
> Links to javadoc from the site pages do not work in the src dist because it does not
include the javadoc under docs.
> --------------------------------------------------------------------------------------------------------------------
>
>                 Key: LUCENE-1897
>                 URL: https://issues.apache.org/jira/browse/LUCENE-1897
>             Project: Lucene - Java
>          Issue Type: Bug
>          Components: Javadocs
>            Reporter: Mark Miller
>            Priority: Minor
>             Fix For: 2.9
>
>
> Links to javadoc from the site pages do not work in the src dist because it does not
include the javadoc under docs.

-- 
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.


---------------------------------------------------------------------
To unsubscribe, e-mail: java-dev-unsubscribe@lucene.apache.org
For additional commands, e-mail: java-dev-help@lucene.apache.org


Mime
View raw message