You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@manifoldcf.apache.org by "Karl Wright (JIRA)" <ji...@apache.org> on 2011/05/02 00:02:03 UTC

[jira] [Created] (CONNECTORS-194) Forrest doc build always gets an error because of relative references to javadoc roots

Forrest doc build always gets an error because of relative references to javadoc roots
--------------------------------------------------------------------------------------

                 Key: CONNECTORS-194
                 URL: https://issues.apache.org/jira/browse/CONNECTORS-194
             Project: ManifoldCF
          Issue Type: Improvement
          Components: Documentation
    Affects Versions: ManifoldCF 0.1, ManifoldCF 0.2, ManifoldCF next
            Reporter: Karl Wright


Forrest is not very happy with generating a relative link to the javadoc roots, since the javadoc itself is not under Forrest's control.  Somebody needs to find a better way of handling this.


--
This message is automatically generated by JIRA.
For more information on JIRA, see: http://www.atlassian.com/software/jira

[jira] [Updated] (CONNECTORS-194) Forrest doc build always gets an error because of relative references to javadoc roots

Posted by "Erlend Garåsen (JIRA)" <ji...@apache.org>.
     [ https://issues.apache.org/jira/browse/CONNECTORS-194?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]

Erlend Garåsen updated CONNECTORS-194:
--------------------------------------

    Attachment: CONNECTORS-194.patch

The generated Javadocs will now be available from:
doc/api/

The location of javadoc.html has not been changed.

Some javadocs were not build, such as the Sharepoint connector, probably because I haven't installed required resources and jars.

> Forrest doc build always gets an error because of relative references to javadoc roots
> --------------------------------------------------------------------------------------
>
>                 Key: CONNECTORS-194
>                 URL: https://issues.apache.org/jira/browse/CONNECTORS-194
>             Project: ManifoldCF
>          Issue Type: Improvement
>          Components: Documentation
>    Affects Versions: ManifoldCF 0.1, ManifoldCF 0.2, ManifoldCF next
>            Reporter: Karl Wright
>         Attachments: CONNECTORS-194.patch
>
>
> Forrest is not very happy with generating a relative link to the javadoc roots, since the javadoc itself is not under Forrest's control.  Somebody needs to find a better way of handling this.

--
This message is automatically generated by JIRA.
For more information on JIRA, see: http://www.atlassian.com/software/jira

[jira] [Issue Comment Edited] (CONNECTORS-194) Forrest doc build always gets an error because of relative references to javadoc roots

Posted by "Karl Wright (JIRA)" <ji...@apache.org>.
    [ https://issues.apache.org/jira/browse/CONNECTORS-194?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=13028282#comment-13028282 ] 

Karl Wright edited comment on CONNECTORS-194 at 5/3/11 4:08 PM:
----------------------------------------------------------------

cli-xconf seems definitely the way to go.  But we're still going to need a jumping-off page that is handled by Forrest (which is what javadoc.html does for us).  Moving javadoc.html to api/index.html for this purpose is also OK if we can get forrest to work with it properly in that location.  If the "api" subdirectory is the new place where the javadoc roots are all put, that's fine by me.


      was (Author: kwright@metacarta.com):
    cli-xconf seems definitely the way to go.  But we're still going to need a jumping-off page that is handled by Forrest (which is what javadoc.html does for us) because not all connectors are buildable or can be javadoc'd, depending on the existence of the needed third-party libraries.  If the "api" subdirectory is the new place where the javadoc roots are all put, that's fine by me.

  
> Forrest doc build always gets an error because of relative references to javadoc roots
> --------------------------------------------------------------------------------------
>
>                 Key: CONNECTORS-194
>                 URL: https://issues.apache.org/jira/browse/CONNECTORS-194
>             Project: ManifoldCF
>          Issue Type: Improvement
>          Components: Documentation
>    Affects Versions: ManifoldCF 0.1, ManifoldCF 0.2, ManifoldCF next
>            Reporter: Karl Wright
>
> Forrest is not very happy with generating a relative link to the javadoc roots, since the javadoc itself is not under Forrest's control.  Somebody needs to find a better way of handling this.

--
This message is automatically generated by JIRA.
For more information on JIRA, see: http://www.atlassian.com/software/jira

[jira] [Updated] (CONNECTORS-194) Forrest doc build always gets an error because of relative references to javadoc roots

Posted by "Karl Wright (JIRA)" <ji...@apache.org>.
     [ https://issues.apache.org/jira/browse/CONNECTORS-194?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]

Karl Wright updated CONNECTORS-194:
-----------------------------------

       Resolution: Fixed
    Fix Version/s: ManifoldCF next
           Status: Resolved  (was: Patch Available)

r1100833
r1100835


> Forrest doc build always gets an error because of relative references to javadoc roots
> --------------------------------------------------------------------------------------
>
>                 Key: CONNECTORS-194
>                 URL: https://issues.apache.org/jira/browse/CONNECTORS-194
>             Project: ManifoldCF
>          Issue Type: Improvement
>          Components: Documentation
>    Affects Versions: ManifoldCF 0.1, ManifoldCF 0.2, ManifoldCF next
>            Reporter: Karl Wright
>             Fix For: ManifoldCF next
>
>         Attachments: CONNECTORS-194.patch
>
>
> Forrest is not very happy with generating a relative link to the javadoc roots, since the javadoc itself is not under Forrest's control.  Somebody needs to find a better way of handling this.

--
This message is automatically generated by JIRA.
For more information on JIRA, see: http://www.atlassian.com/software/jira

[jira] [Updated] (CONNECTORS-194) Forrest doc build always gets an error because of relative references to javadoc roots

Posted by "Erlend Garåsen (JIRA)" <ji...@apache.org>.
     [ https://issues.apache.org/jira/browse/CONNECTORS-194?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]

Erlend Garåsen updated CONNECTORS-194:
--------------------------------------

    Status: Patch Available  (was: Open)

The generated Javadocs will now be available from:
doc/api/

The location of javadoc.html has not been changed.


> Forrest doc build always gets an error because of relative references to javadoc roots
> --------------------------------------------------------------------------------------
>
>                 Key: CONNECTORS-194
>                 URL: https://issues.apache.org/jira/browse/CONNECTORS-194
>             Project: ManifoldCF
>          Issue Type: Improvement
>          Components: Documentation
>    Affects Versions: ManifoldCF 0.1, ManifoldCF 0.2, ManifoldCF next
>            Reporter: Karl Wright
>         Attachments: CONNECTORS-194.patch
>
>
> Forrest is not very happy with generating a relative link to the javadoc roots, since the javadoc itself is not under Forrest's control.  Somebody needs to find a better way of handling this.

--
This message is automatically generated by JIRA.
For more information on JIRA, see: http://www.atlassian.com/software/jira

[jira] [Commented] (CONNECTORS-194) Forrest doc build always gets an error because of relative references to javadoc roots

Posted by "Karl Wright (JIRA)" <ji...@apache.org>.
    [ https://issues.apache.org/jira/browse/CONNECTORS-194?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=13028282#comment-13028282 ] 

Karl Wright commented on CONNECTORS-194:
----------------------------------------

cli-xconf seems definitely the way to go.  But we're still going to need a jumping-off page that is handled by Forrest (which is what javadoc.html does for us) because not all connectors are buildable or can be javadoc'd, depending on the existence of the needed third-party libraries.  If the "api" subdirectory is the new place where the javadoc roots are all put, that's fine by me.


> Forrest doc build always gets an error because of relative references to javadoc roots
> --------------------------------------------------------------------------------------
>
>                 Key: CONNECTORS-194
>                 URL: https://issues.apache.org/jira/browse/CONNECTORS-194
>             Project: ManifoldCF
>          Issue Type: Improvement
>          Components: Documentation
>    Affects Versions: ManifoldCF 0.1, ManifoldCF 0.2, ManifoldCF next
>            Reporter: Karl Wright
>
> Forrest is not very happy with generating a relative link to the javadoc roots, since the javadoc itself is not under Forrest's control.  Somebody needs to find a better way of handling this.

--
This message is automatically generated by JIRA.
For more information on JIRA, see: http://www.atlassian.com/software/jira

[jira] [Commented] (CONNECTORS-194) Forrest doc build always gets an error because of relative references to javadoc roots

Posted by "Erlend Garåsen (JIRA)" <ji...@apache.org>.
    [ https://issues.apache.org/jira/browse/CONNECTORS-194?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=13030515#comment-13030515 ] 

Erlend Garåsen commented on CONNECTORS-194:
-------------------------------------------

I think javadoc.html should be kept outside the api directory since it's part of the documentation and not a generated API page.

I will upload a patch later today after I have run tests and double-checked that I haven't done something wrong.

> Forrest doc build always gets an error because of relative references to javadoc roots
> --------------------------------------------------------------------------------------
>
>                 Key: CONNECTORS-194
>                 URL: https://issues.apache.org/jira/browse/CONNECTORS-194
>             Project: ManifoldCF
>          Issue Type: Improvement
>          Components: Documentation
>    Affects Versions: ManifoldCF 0.1, ManifoldCF 0.2, ManifoldCF next
>            Reporter: Karl Wright
>
> Forrest is not very happy with generating a relative link to the javadoc roots, since the javadoc itself is not under Forrest's control.  Somebody needs to find a better way of handling this.

--
This message is automatically generated by JIRA.
For more information on JIRA, see: http://www.atlassian.com/software/jira

[jira] [Commented] (CONNECTORS-194) Forrest doc build always gets an error because of relative references to javadoc roots

Posted by "Karl Wright (JIRA)" <ji...@apache.org>.
    [ https://issues.apache.org/jira/browse/CONNECTORS-194?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=13030551#comment-13030551 ] 

Karl Wright commented on CONNECTORS-194:
----------------------------------------

Patch looks great!
I'll commit it tomorrow morning.


> Forrest doc build always gets an error because of relative references to javadoc roots
> --------------------------------------------------------------------------------------
>
>                 Key: CONNECTORS-194
>                 URL: https://issues.apache.org/jira/browse/CONNECTORS-194
>             Project: ManifoldCF
>          Issue Type: Improvement
>          Components: Documentation
>    Affects Versions: ManifoldCF 0.1, ManifoldCF 0.2, ManifoldCF next
>            Reporter: Karl Wright
>         Attachments: CONNECTORS-194.patch
>
>
> Forrest is not very happy with generating a relative link to the javadoc roots, since the javadoc itself is not under Forrest's control.  Somebody needs to find a better way of handling this.

--
This message is automatically generated by JIRA.
For more information on JIRA, see: http://www.atlassian.com/software/jira

[jira] [Commented] (CONNECTORS-194) Forrest doc build always gets an error because of relative references to javadoc roots

Posted by "Erlend Garåsen (JIRA)" <ji...@apache.org>.
    [ https://issues.apache.org/jira/browse/CONNECTORS-194?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=13028276#comment-13028276 ] 

Erlend Garåsen commented on CONNECTORS-194:
-------------------------------------------

I suggest that the path to the Javadoc root is changed from
http://incubator.apache.org/connectors/javadoc.html
to
http://incubator.apache.org/connectors/api/ (index.html)

Then it is much more easier to exclude those docs by creating rules in a cli.xconf file, for example:
<exclude pattern="api/**"/>

Take a look at the following part in the Forrest's faq:
http://forrest.apache.org/docs_0_80/faq.html#cli-xconf

> Forrest doc build always gets an error because of relative references to javadoc roots
> --------------------------------------------------------------------------------------
>
>                 Key: CONNECTORS-194
>                 URL: https://issues.apache.org/jira/browse/CONNECTORS-194
>             Project: ManifoldCF
>          Issue Type: Improvement
>          Components: Documentation
>    Affects Versions: ManifoldCF 0.1, ManifoldCF 0.2, ManifoldCF next
>            Reporter: Karl Wright
>
> Forrest is not very happy with generating a relative link to the javadoc roots, since the javadoc itself is not under Forrest's control.  Somebody needs to find a better way of handling this.

--
This message is automatically generated by JIRA.
For more information on JIRA, see: http://www.atlassian.com/software/jira