You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@dubbo.apache.org by Andrea Del Bene <an...@gmail.com> on 2018/07/03 17:02:05 UTC
CI and JavaDoc
Hi Dubbers!
I know you are super busy-at the moment, but I'd like to add to your TODO
list a task to host Dubbo JavaDoc on your Apache site. At the moment
JavaDocs are available at http://www.javadoc.io but it would be nice to
host them in-house. Normally this is done on the CI server at the end of
the build coping javadoc files to the site server.
Thank you in advance
Andrea Del Bene.
Apache Wicket committer.
Re: CI and JavaDoc
Posted by YunKun Huang <hy...@apache.org>.
Not sure if it's possible, but I think we can still use travis ci to run build and at same time use apache ci to publish javadoc only.
On 2018/07/11 02:18:18, Huxing Zhang <hu...@apache.org> wrote:
> On Tue, Jul 10, 2018 at 11:26 PM, Mark Thomas <ma...@apache.org> wrote:
> > On 04/07/18 02:18, Huxing Zhang wrote:
> >> Hi,
> >>
> >> On Wed, Jul 4, 2018 at 1:02 AM, Andrea Del Bene <an...@gmail.com> wrote:
> >>> Hi Dubbers!
> >>>
> >>> I know you are super busy-at the moment, but I'd like to add to your TODO
> >>> list a task to host Dubbo JavaDoc on your Apache site. At the moment
> >>> JavaDocs are available at http://www.javadoc.io but it would be nice to
> >>> host them in-house. Normally this is done on the CI server at the end of
> >>> the build coping javadoc files to the site server.
> >>
> >> Welcome!
> >>
> >> +1 to host them in-house, I saw tomcat's Javadoc hosting on the
> >> official site[1].
> >>
> >> Actually the Javadoc files are generated in Travis CI for every
> >> commit, but I am not quite sure how to sync these files to the site
> >> server.
> >>
> >> Maybe there is not enough privilege for a 3rd-party service to have
> >> write access to apache repositories.
> >>
> >> Do you have any experience on how to achieve that?
> >
> > The Tomcat docs (including the Javadoc) are only updated (effectively
> > manually) when we do a release so they always refer to the latest
> > release of each branch.
>
> I think hosting the latest stable release is enough for most of the cases.
> For the users that is interested in a version under development, they
> can generated javadoc locally.
>
> >
> > If you publish docs from the CI server then you run the risk of the docs
> > and the latest release getting out of sync and that can cause user
> > confusion.
>
> Agree.
>
> >
> > Other projects publish the docs for the latest release and the docs for
> > the current development HEAD in separate areas on their website.
> >
> > If you want to publish from CI to the project website you'll need to do
> > that from an ASF owned CI system.
>
> I think Travis CI is working perfectly, I don't see any reason to migrate.
>
> >
> > Mark
> >
> >>
> >>
> >> [1] http://tomcat.apache.org/tomcat-8.5-doc/api/index.html
> >>
> >>>
> >>> Thank you in advance
> >>>
> >>> Andrea Del Bene.
> >>> Apache Wicket committer.
> >>
> >>
> >>
> >
>
>
>
> --
> Best Regards！
> Huxing
>
Re: CI and JavaDoc
Posted by Huxing Zhang <hu...@apache.org>.
On Tue, Jul 10, 2018 at 11:26 PM, Mark Thomas <ma...@apache.org> wrote:
> On 04/07/18 02:18, Huxing Zhang wrote:
>> Hi,
>>
>> On Wed, Jul 4, 2018 at 1:02 AM, Andrea Del Bene <an...@gmail.com> wrote:
>>> Hi Dubbers!
>>>
>>> I know you are super busy-at the moment, but I'd like to add to your TODO
>>> list a task to host Dubbo JavaDoc on your Apache site. At the moment
>>> JavaDocs are available at http://www.javadoc.io but it would be nice to
>>> host them in-house. Normally this is done on the CI server at the end of
>>> the build coping javadoc files to the site server.
>>
>> Welcome!
>>
>> +1 to host them in-house, I saw tomcat's Javadoc hosting on the
>> official site[1].
>>
>> Actually the Javadoc files are generated in Travis CI for every
>> commit, but I am not quite sure how to sync these files to the site
>> server.
>>
>> Maybe there is not enough privilege for a 3rd-party service to have
>> write access to apache repositories.
>>
>> Do you have any experience on how to achieve that?
>
> The Tomcat docs (including the Javadoc) are only updated (effectively
> manually) when we do a release so they always refer to the latest
> release of each branch.
I think hosting the latest stable release is enough for most of the cases.
For the users that is interested in a version under development, they
can generated javadoc locally.
>
> If you publish docs from the CI server then you run the risk of the docs
> and the latest release getting out of sync and that can cause user
> confusion.
Agree.
>
> Other projects publish the docs for the latest release and the docs for
> the current development HEAD in separate areas on their website.
>
> If you want to publish from CI to the project website you'll need to do
> that from an ASF owned CI system.
I think Travis CI is working perfectly, I don't see any reason to migrate.
>
> Mark
>
>>
>>
>> [1] http://tomcat.apache.org/tomcat-8.5-doc/api/index.html
>>
>>>
>>> Thank you in advance
>>>
>>> Andrea Del Bene.
>>> Apache Wicket committer.
>>
>>
>>
>
--
Best Regards！
Huxing
Re: CI and JavaDoc
Posted by Mark Thomas <ma...@apache.org>.
On 04/07/18 02:18, Huxing Zhang wrote:
> Hi,
>
> On Wed, Jul 4, 2018 at 1:02 AM, Andrea Del Bene <an...@gmail.com> wrote:
>> Hi Dubbers!
>>
>> I know you are super busy-at the moment, but I'd like to add to your TODO
>> list a task to host Dubbo JavaDoc on your Apache site. At the moment
>> JavaDocs are available at http://www.javadoc.io but it would be nice to
>> host them in-house. Normally this is done on the CI server at the end of
>> the build coping javadoc files to the site server.
>
> Welcome!
>
> +1 to host them in-house, I saw tomcat's Javadoc hosting on the
> official site[1].
>
> Actually the Javadoc files are generated in Travis CI for every
> commit, but I am not quite sure how to sync these files to the site
> server.
>
> Maybe there is not enough privilege for a 3rd-party service to have
> write access to apache repositories.
>
> Do you have any experience on how to achieve that?
The Tomcat docs (including the Javadoc) are only updated (effectively
manually) when we do a release so they always refer to the latest
release of each branch.
If you publish docs from the CI server then you run the risk of the docs
and the latest release getting out of sync and that can cause user
confusion.
Other projects publish the docs for the latest release and the docs for
the current development HEAD in separate areas on their website.
If you want to publish from CI to the project website you'll need to do
that from an ASF owned CI system.
Mark
>
>
> [1] http://tomcat.apache.org/tomcat-8.5-doc/api/index.html
>
>>
>> Thank you in advance
>>
>> Andrea Del Bene.
>> Apache Wicket committer.
>
>
>
Re: CI and JavaDoc
Posted by Ian Luo <ia...@gmail.com>.
It's a good advice anyway to publish javadoc. We will consider to integrate
it in CI procedure.
On Wed, Jul 4, 2018 at 9:19 AM Huxing Zhang <hu...@apache.org> wrote:
> Hi,
>
> On Wed, Jul 4, 2018 at 1:02 AM, Andrea Del Bene <an...@gmail.com>
> wrote:
> > Hi Dubbers!
> >
> > I know you are super busy-at the moment, but I'd like to add to your TODO
> > list a task to host Dubbo JavaDoc on your Apache site. At the moment
> > JavaDocs are available at http://www.javadoc.io but it would be nice to
> > host them in-house. Normally this is done on the CI server at the end of
> > the build coping javadoc files to the site server.
>
> Welcome!
>
> +1 to host them in-house, I saw tomcat's Javadoc hosting on the
> official site[1].
>
> Actually the Javadoc files are generated in Travis CI for every
> commit, but I am not quite sure how to sync these files to the site
> server.
>
> Maybe there is not enough privilege for a 3rd-party service to have
> write access to apache repositories.
>
> Do you have any experience on how to achieve that?
>
>
> [1] http://tomcat.apache.org/tomcat-8.5-doc/api/index.html
>
> >
> > Thank you in advance
> >
> > Andrea Del Bene.
> > Apache Wicket committer.
>
>
>
> --
> Best Regards！
> Huxing
>
Re: CI and JavaDoc
Posted by Huxing Zhang <hu...@apache.org>.
Hi,
On Wed, Jul 4, 2018 at 1:02 AM, Andrea Del Bene <an...@gmail.com> wrote:
> Hi Dubbers!
>
> I know you are super busy-at the moment, but I'd like to add to your TODO
> list a task to host Dubbo JavaDoc on your Apache site. At the moment
> JavaDocs are available at http://www.javadoc.io but it would be nice to
> host them in-house. Normally this is done on the CI server at the end of
> the build coping javadoc files to the site server.
Welcome!
+1 to host them in-house, I saw tomcat's Javadoc hosting on the
official site[1].
Actually the Javadoc files are generated in Travis CI for every
commit, but I am not quite sure how to sync these files to the site
server.
Maybe there is not enough privilege for a 3rd-party service to have
write access to apache repositories.
Do you have any experience on how to achieve that?
[1] http://tomcat.apache.org/tomcat-8.5-doc/api/index.html
>
> Thank you in advance
>
> Andrea Del Bene.
> Apache Wicket committer.
--
Best Regards！
Huxing