+ 1, I agreed with this idea.

Michael Marshall <mmarsh...@apache.org> 于2022年7月7日周四 12:09写道:

> > - shared modules (pulsar-common...)
>
> Just to be clear, we do not host javadocs for the pulsar-common
> module. We only have them for the Admin API, the Java Client API, the
> pulsar-broker (for now) and the Function API.
>
> Thanks,
> Michael
>
> On Wed, Jul 6, 2022 at 4:51 AM Enrico Olivelli <eolive...@gmail.com>
> wrote:
> >
> > Micheal,
> > I fully agree
> > we need only the javadocs for:
> > - the client
> > - pulsar functions and pulsar IO
> > - shared modules (pulsar-common...)
> >
> >
> > Enrico
> >
> > Il giorno mer 6 lug 2022 alle ore 05:36 Michael Marshall
> > <mmarsh...@apache.org> ha scritto:
> > >
> > > Hi Pulsar Community,
> > >
> > > We currently host the generated Pulsar Broker Javadocs on our website.
> > > You can find them here [0].
> > >
> > > I cannot find any references to these docs in the actual pulsar
> > > documentation, which indicates to me that these are not used.
> > > (Searching for `api/pulsar-broker` returns nothing.)
> > >
> > > Additionally, these Javadocs take up a lot of space (about 267 MB
> > > uncompressed in the apache/pulsar-site repo) and will take up a lot
> > > more space if we start generating the docs correctly for each patch
> > > release, as I propose in  PR [1]. Note that the PR currently adds over
> > > 8 million lines of generated Javadocs where 5,208,309 are from the
> > > newly created `pulsar-broker` directory, which only contains broker
> > > Javadocs. That directory is 304 MB uncompressed.
> > >
> > > Before I merge [1], I want to confirm whether we should continue
> > > hosting these Javadocs. In my opinion, we should only generate and
> > > host Javadocs that are used by the community, and since these are both
> > > unreferenced and rather large, I think we should remove them.
> > >
> > > Does anyone feel strongly about keeping the generated Pulsar Broker
> > > Javadocs on the website?
> > >
> > > If I do not hear any feedback requesting that we keep these docs, I
> > > will remove them from the website at the end of this week. Note that
> > > these docs can be generated trivially, so removing them from the
> > > website is reversible.
> > >
> > > Thanks,
> > > Michael
> > >
> > > [0] https://pulsar.apache.org/api/pulsar-broker/
> > > [1] https://github.com/apache/pulsar-site/pull/133
>

Reply via email to