Re: [discuss]About api documentation

[Guangning E <eg...@gmail.com>]

The old version of api documents are now available:

broker:
http://pulsar.apache.org/api/pulsar-broker/

functions:
http://pulsar.apache.org/api/pulsar-functions/2.2.0/
http://pulsar.apache.org/api/pulsar-functions/2.2.1/
http://pulsar.apache.org/api/pulsar-functions/2.3.0/
http://pulsar.apache.org/api/pulsar-functions/2.3.1/
http://pulsar.apache.org/api/pulsar-functions/2.3.2/
http://pulsar.apache.org/api/pulsar-functions/2.4.0/
http://pulsar.apache.org/api/pulsar-functions/2.4.1/
http://pulsar.apache.org/api/pulsar-functions/2.4.2/

admin:
http://pulsar.apache.org/api/admin/2.2.0/
http://pulsar.apache.org/api/admin/2.2.1/
http://pulsar.apache.org/api/admin/2.3.0/
http://pulsar.apache.org/api/admin/2.3.1/
http://pulsar.apache.org/api/admin/2.3.2/
http://pulsar.apache.org/api/admin/2.4.0/
http://pulsar.apache.org/api/admin/2.4.1/
http://pulsar.apache.org/api/admin/2.4.2/

client:
http://pulsar.apache.org/api/client/2.2.0/
http://pulsar.apache.org/api/client/2.2.1/
http://pulsar.apache.org/api/client/2.3.0/
http://pulsar.apache.org/api/client/2.3.1/
http://pulsar.apache.org/api/client/2.3.2/
http://pulsar.apache.org/api/client/2.4.0/
http://pulsar.apache.org/api/client/2.4.1/
http://pulsar.apache.org/api/client/2.4.2/

python:
http://pulsar.apache.org/api/python/2.2.0/
http://pulsar.apache.org/api/python/2.2.1/
http://pulsar.apache.org/api/python/2.3.0/
http://pulsar.apache.org/api/python/2.3.1/
http://pulsar.apache.org/api/python/2.3.2/
http://pulsar.apache.org/api/python/2.4.0/
http://pulsar.apache.org/api/python/2.4.1/
http://pulsar.apache.org/api/python/2.4.2/

cpp:
http://pulsar.apache.org/api/cpp/2.2.0/
http://pulsar.apache.org/api/cpp/2.2.1/
http://pulsar.apache.org/api/cpp/2.3.0/
http://pulsar.apache.org/api/cpp/2.3.1/
http://pulsar.apache.org/api/cpp/2.4.0/
http://pulsar.apache.org/api/cpp/2.4.1/
http://pulsar.apache.org/api/cpp/2.4.2/

Thanks,
Guangning

Guangning E <eg...@gmail.com> 于2019年11月4日周一 上午11:29写道：

> @Sijie Guo <gu...@gmail.com>  Thank you for your advice, I will try it.
>
> Thanks,
> Guangning
>
> xiaolong ran <ra...@gmail.com> 于2019年11月3日周日 上午11:44写道：
>
>> Thanks Guangning E work for this, LGTM +1
>>
>>
>> > 在 2019年11月2日，上午9:51，Guangning E <eg...@gmail.com> 写道：
>> >
>> > Recently, community users complained about API documents, including
>> > missing, wrong version, wrong link, contradictory content, etc. After
>> doing
>> > some work and communicating with the asf framework group through Jira
>> > https://issues.apache.org/jira/browse/INFRA-19358, I found that the
>> latest
>> > version of API documents has been correctly generated, but it has not
>> yet
>> > been displayed.
>> > python:
>> > http://pulsar.apache.org/api/python/2.5.0-SNAPSHOT/
>> > CPP:
>> > http://pulsar.apache.org/api/cpp/2.5.0-SNAPSHOT/
>> > pulsar-admin:
>> > http://pulsar.apache.org/api/admin/2.5.0-SNAPSHOT/
>> > pulsar-broker:
>> > http://pulsar.apache.org/api/pulsar-broker/2.5.0-SNAPSHOT/
>> > pulsar-functions:
>> > http://pulsar.apache.org/api/pulsar-functions/2.5.0-SNAPSHOT/
>> > pulsar-client:
>> > http://pulsar.apache.org/api/client/2.5.0-SNAPSHOT/
>> >
>> > Therefore, I want to fix these problems through the following steps:
>> >
>> > 1. Move the latest snapshot version (Snapshot versions always change,
>> which
>> > is not good for links.) of the document to a master directory (this is
>> done
>> > automatically)
>> > 2. Directly add the documents of the old version to the asf-site branch
>> > (e.g. 2.4.1, 2.4.0, 2.3.1, 2.3.0). a pull request to the asf-site
>> branch is
>> > required
>> > 3. Fix the inconsistency between API documents and official documents
>> > 4. Add portal links to official website document pages according to
>> version
>> >
>> > What do you think?
>> >
>> > Thanks,
>> > Guangning
>>
>>