You are viewing a plain text version of this content. The canonical link for it is here.
Posted to oak-dev@jackrabbit.apache.org by Michael Dürig <md...@apache.org> on 2015/07/14 09:36:00 UTC
[Discuss] Oak Javadocs on www.javadoc.io
Hi,
http://www.javadoc.io/ provides simple and fast Javadoc hosting for
anything on Maven Central: requesting the Javadocs for an artifact
through a respectively constructed URL is all that's needed.
For example http://www.javadoc.io/doc/org.apache.jackrabbit/oak-jcr/
would always point to the latest release of oak-jcr, while older release
(e.g. 0.11) would be available at
http://www.javadoc.io/doc/org.apache.jackrabbit/oak-jcr/0.11.
When an URL is requested for the first time it takes roughly 10 minutes
for the Javadoc to be pulled to the site.
What do people think about leveraging this mechanism for
http://jackrabbit.apache.org/oak/docs/? Currently we only host Javadocs
for the latest release. Should we start linking to
http://www.javadoc.io/ for older releases? Should we stop hosting
Javadocs ourselves entirely in favour of http://www.javadoc.io/? Or
should we not change anything at all?
Michael
Re: [Discuss] Oak Javadocs on www.javadoc.io
Posted by Marcel Reutegger <mr...@adobe.com>.
Hi,
our current JavaDocs cover a lot of internal classes, which
are probably not that useful to someone browsing the docs.
I would rather limit JavaDocs to public/exported API.
Regards
Marcel
On 14/07/15 09:36, "Michael Dürig" wrote:
>Hi,
>
>http://www.javadoc.io/ provides simple and fast Javadoc hosting for
>anything on Maven Central: requesting the Javadocs for an artifact
>through a respectively constructed URL is all that's needed.
>
>For example http://www.javadoc.io/doc/org.apache.jackrabbit/oak-jcr/
>would always point to the latest release of oak-jcr, while older release
>(e.g. 0.11) would be available at
>http://www.javadoc.io/doc/org.apache.jackrabbit/oak-jcr/0.11.
>
>When an URL is requested for the first time it takes roughly 10 minutes
>for the Javadoc to be pulled to the site.
>
>What do people think about leveraging this mechanism for
>http://jackrabbit.apache.org/oak/docs/? Currently we only host Javadocs
>for the latest release. Should we start linking to
>http://www.javadoc.io/ for older releases? Should we stop hosting
>Javadocs ourselves entirely in favour of http://www.javadoc.io/? Or
>should we not change anything at all?
>
>Michael
Re: [Discuss] Oak Javadocs on www.javadoc.io
Posted by Davide Giannella <da...@apache.org>.
On 14/07/2015 08:36, Michael Dürig wrote:
>
> ...
> What do people think about leveraging this mechanism for
> http://jackrabbit.apache.org/oak/docs/? Currently we only host
> Javadocs for the latest release. Should we start linking to
> http://www.javadoc.io/ for older releases? Should we stop hosting
> Javadocs ourselves entirely in favour of http://www.javadoc.io/? Or
> should we not change anything at all?
I think the fact we don't have 1.2 and 1.0 javadocs available is bad.
Right now we host the 1.3.x which I generates at every 1.3 release with
a bit of "hacking" around with checkins, site and site-deploy.
What we could do, IMO is:
- hosting always and only -SNAPSHOT
- linking 1.3, 1,2 and 1.0 to javadoc.io.
- updating our website linking the latest released version.
What I don't like of javadoc.io is the fact that you have to get to the
maven artifact for the javadoc and it doesn't have something like
jackrabbit-oak/index.html all the javadocs like in
http://jackrabbit.apache.org/oak/docs/apidocs/index.html.
Davide
Re: [Discuss] Oak Javadocs on www.javadoc.io
Posted by Michael Dürig <md...@apache.org>.
At http://svn.apache.org/r1691883 I added links to older releases but
kept the aggregated Javadocs of the current release on our own site.
Michael
On 14.7.15 9:36 , Michael Dürig wrote:
>
> Hi,
>
> http://www.javadoc.io/ provides simple and fast Javadoc hosting for
> anything on Maven Central: requesting the Javadocs for an artifact
> through a respectively constructed URL is all that's needed.
>
> For example http://www.javadoc.io/doc/org.apache.jackrabbit/oak-jcr/
> would always point to the latest release of oak-jcr, while older release
> (e.g. 0.11) would be available at
> http://www.javadoc.io/doc/org.apache.jackrabbit/oak-jcr/0.11.
>
> When an URL is requested for the first time it takes roughly 10 minutes
> for the Javadoc to be pulled to the site.
>
> What do people think about leveraging this mechanism for
> http://jackrabbit.apache.org/oak/docs/? Currently we only host Javadocs
> for the latest release. Should we start linking to
> http://www.javadoc.io/ for older releases? Should we stop hosting
> Javadocs ourselves entirely in favour of http://www.javadoc.io/? Or
> should we not change anything at all?
>
> Michael