You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@commons.apache.org by Gary Gregory <ga...@gmail.com> on 2022/08/21 13:03:54 UTC
[RNG] No Javadoc link anywhere in the site menus?
Hi RNG,
When I look at https://commons.apache.org/proper/commons-rng/ I do not see
a link to the Javadoc subsite in the menus of the left side of the site. Am
I missing it? It is usually at the very least in the Project Reports
section but I do not see it. What am I missing?
Gary
Re: [RNG] No Javadoc link anywhere in the site menus?
Posted by Bernd Eckenfels <ec...@zusammenkunft.net>.
BTW just an easy Trick, VFS is also a Multi-Module built but we just added a manual Javadoc link to the toplevel site:
https://github.com/apache/commons-vfs/blob/6590045c11a341217f68750cacb0880bcc3443d7/src/site/site.xml#L33
Gruss
Bernd
--
http://bernd.eckenfels.net
________________________________
Von: Alex Herbert <al...@gmail.com>
Gesendet: Monday, August 22, 2022 1:19:41 PM
An: Commons Developers List <de...@commons.apache.org>
Betreff: Re: [RNG] No Javadoc link anywhere in the site menus?
On Sun, 21 Aug 2022 at 14:24, Gary Gregory <ga...@gmail.com> wrote:
>
> On Sun, Aug 21, 2022 at 9:23 AM Gary Gregory <ga...@gmail.com>
> wrote:
>
> > Hm... I guess an aggregate Javadoc is on my wish list, maybe one day...
>
Commons RNG has an aggregate project activated by a profile in the parent
pom named 'docs'. It creates aggregate javadoc and jacoco reports as these
plugins require the tools are configured in a module that depends on all
the other modules. I added it for the current dev version for easier
browsing of coverage data and the javadoc API. It is not used during
release. I am wondering if a site build including that profile would create
a further module in the modules menu where the aggregate reports are shown.
A bit of extra code could then be added to the top level site configuration
to show a link to the aggregate javadoc.
It would be a good place to start investigating an aggregate javadoc for
the site. Then address the issue in the release guide of where to copy the
javadoc for the Apache long term archive. Currently all modules have their
own sub-directory for the javadoc archive e.g.
https://commons.apache.org/proper/commons-rng/commons-rng-client-api/apidocs/index.html
https://commons.apache.org/rng/commons-rng-client-api/javadocs/api-1.4/index.html
https://commons.apache.org/rng/commons-rng-client-api/javadocs/api-1.3/index.html
etc ...
I would propose an aggregate javadoc could live at the top level as if a
single module component:
Latest:
https://commons.apache.org/proper/commons-rng/apidocs/index.html
Release archive:
https://commons.apache.org/rng/commons-rng/javadocs/api-1.4/index.html
However I am unfamiliar with the exact requirements for the javadoc
archive. Currently the release has a script to copy all the javadocs from
the release site build to the archive location. The aggregate javadoc would
have to be added to this release step.
Alex
Re: [RNG] No Javadoc link anywhere in the site menus?
Posted by Alex Herbert <al...@gmail.com>.
On Sun, 21 Aug 2022 at 14:24, Gary Gregory <ga...@gmail.com> wrote:
>
> On Sun, Aug 21, 2022 at 9:23 AM Gary Gregory <ga...@gmail.com>
> wrote:
>
> > Hm... I guess an aggregate Javadoc is on my wish list, maybe one day...
>
Commons RNG has an aggregate project activated by a profile in the parent
pom named 'docs'. It creates aggregate javadoc and jacoco reports as these
plugins require the tools are configured in a module that depends on all
the other modules. I added it for the current dev version for easier
browsing of coverage data and the javadoc API. It is not used during
release. I am wondering if a site build including that profile would create
a further module in the modules menu where the aggregate reports are shown.
A bit of extra code could then be added to the top level site configuration
to show a link to the aggregate javadoc.
It would be a good place to start investigating an aggregate javadoc for
the site. Then address the issue in the release guide of where to copy the
javadoc for the Apache long term archive. Currently all modules have their
own sub-directory for the javadoc archive e.g.
https://commons.apache.org/proper/commons-rng/commons-rng-client-api/apidocs/index.html
https://commons.apache.org/rng/commons-rng-client-api/javadocs/api-1.4/index.html
https://commons.apache.org/rng/commons-rng-client-api/javadocs/api-1.3/index.html
etc ...
I would propose an aggregate javadoc could live at the top level as if a
single module component:
Latest:
https://commons.apache.org/proper/commons-rng/apidocs/index.html
Release archive:
https://commons.apache.org/rng/commons-rng/javadocs/api-1.4/index.html
However I am unfamiliar with the exact requirements for the javadoc
archive. Currently the release has a script to copy all the javadocs from
the release site build to the archive location. The aggregate javadoc would
have to be added to this release step.
Alex
Re: [RNG] No Javadoc link anywhere in the site menus?
Posted by Gary Gregory <ga...@gmail.com>.
And TY for the quick reply!
Gary
On Sun, Aug 21, 2022 at 9:23 AM Gary Gregory <ga...@gmail.com> wrote:
> Hm... I guess an aggregate Javadoc is on my wish list, maybe one day...
>
> Gary
>
> On Sun, Aug 21, 2022 at 9:17 AM Alex Herbert <al...@gmail.com>
> wrote:
>
>> In the multi module site you have to descend to a sub module to see the
>> javadoc links for that module. There is no top level aggregate javadoc.
>> This has been the multi module layout for a long time and is the same in
>> math and geometry too.
>>
>> Alex
>>
>> On Sun, 21 Aug 2022, 14:04 Gary Gregory, <ga...@gmail.com> wrote:
>>
>> > Hi RNG,
>> >
>> > When I look at https://commons.apache.org/proper/commons-rng/ I do not
>> see
>> > a link to the Javadoc subsite in the menus of the left side of the
>> site. Am
>> > I missing it? It is usually at the very least in the Project Reports
>> > section but I do not see it. What am I missing?
>> >
>> > Gary
>> >
>>
>
Re: [RNG] No Javadoc link anywhere in the site menus?
Posted by Gary Gregory <ga...@gmail.com>.
Hm... I guess an aggregate Javadoc is on my wish list, maybe one day...
Gary
On Sun, Aug 21, 2022 at 9:17 AM Alex Herbert <al...@gmail.com>
wrote:
> In the multi module site you have to descend to a sub module to see the
> javadoc links for that module. There is no top level aggregate javadoc.
> This has been the multi module layout for a long time and is the same in
> math and geometry too.
>
> Alex
>
> On Sun, 21 Aug 2022, 14:04 Gary Gregory, <ga...@gmail.com> wrote:
>
> > Hi RNG,
> >
> > When I look at https://commons.apache.org/proper/commons-rng/ I do not
> see
> > a link to the Javadoc subsite in the menus of the left side of the site.
> Am
> > I missing it? It is usually at the very least in the Project Reports
> > section but I do not see it. What am I missing?
> >
> > Gary
> >
>
Re: [RNG] No Javadoc link anywhere in the site menus?
Posted by Alex Herbert <al...@gmail.com>.
On Sun, 21 Aug 2022, 14:17 Alex Herbert, <al...@gmail.com> wrote:
> In the multi module site you have to descend to a sub module to see the
> javadoc links for that module. There is no top level aggregate javadoc.
> This has been the multi module layout for a long time and is the same in
> math and geometry too.
>
> Alex
>
See https://commons.apache.org/proper/commons-rng/modules.html
And click any module. Then you should have all the javadoc from released
versions in the standard top left menu.
Re: [RNG] No Javadoc link anywhere in the site menus?
Posted by Alex Herbert <al...@gmail.com>.
In the multi module site you have to descend to a sub module to see the
javadoc links for that module. There is no top level aggregate javadoc.
This has been the multi module layout for a long time and is the same in
math and geometry too.
Alex
On Sun, 21 Aug 2022, 14:04 Gary Gregory, <ga...@gmail.com> wrote:
> Hi RNG,
>
> When I look at https://commons.apache.org/proper/commons-rng/ I do not see
> a link to the Javadoc subsite in the menus of the left side of the site. Am
> I missing it? It is usually at the very least in the Project Reports
> section but I do not see it. What am I missing?
>
> Gary
>