You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@pulsar.apache.org by Yu <li...@apache.org> on 2023/03/16 12:06:09 UTC
New Pulsar docs (API + CLI) are available!
Hi community,
To improve the developer experience and take Pulsar content to the next
level, recently we (+@hangc0276) have added some new docs as below.
===============
Fresh New Content
===============
- Pulsar API
(https://pulsar.apache.org/docs/next/pulsar-api-overview/)
- Pulsar admin API
→ Overview (https://pulsar.apache.org/docs/next/admin-api-overview/)
→ Use cases (https://pulsar.apache.org/docs/next/admin-api-use-cases/）
→ Features (https://pulsar.apache.org/docs/next/admin-api-features/)
→ Tools (https://pulsar.apache.org/docs/next/admin-api-tools/)
→ Get started (https://pulsar.apache.org/docs/next/admin-api-get-started/)
- Pulsar client API
(https://pulsar.apache.org/docs/next/client-api-overview/)
- Pulsar CLI
→ pulsar-admin: Get started (
https://pulsar.apache.org/docs/next/get-started-pulsar-admin/)
Enjoy reading!
Here [1] are related doc PRs.
We'll add more docs on these topics in the near future.
Feel free to leave your suggestions, TIA!
===============
Acknowledgment
===============
@hangc0276 Huge shout out to you for providing technical input and guidance!
@BewareMyPower @horizonzy A big thank you for your technical support!
===============
[1]
- https://github.com/apache/pulsar-site/pull/462
- https://github.com/apache/pulsar-site/pull/403
- https://github.com/apache/pulsar/pull/19002
- https://github.com/apache/pulsar/pull/18680
Yu
Re: New Pulsar docs (API + CLI) are available!
Posted by Yu <li...@apache.org>.
Thank you, Max and Asaf!
> One small note: https://pulsar.apache.org/docs/next/admin-api-tutorial/ -
I didn't find a tutorial there, mainly setup instructions.
Yes, this is a known issue, which will be optimized later.
On Sun, Mar 19, 2023 at 9:51 PM Asaf Mesika <as...@gmail.com> wrote:
> Good work - this makes the API documentation better for end users and less
> confusing.
>
> One small note: https://pulsar.apache.org/docs/next/admin-api-tutorial/ -
> I
> didn't find a tutorial there, mainly setup instructions.
>
>
> On Fri, Mar 17, 2023 at 11:13 AM Max Xu <ma...@gmail.com> wrote:
>
> > Yu , Thanks for driving this. It looks great!
> >
> > Best,
> > Max Xu
> >
> >
> > On Thu, Mar 16, 2023 at 8:06 PM Yu <li...@apache.org> wrote:
> >
> > > Hi community,
> > >
> > > To improve the developer experience and take Pulsar content to the next
> > > level, recently we (+@hangc0276) have added some new docs as below.
> > >
> > > ===============
> > > Fresh New Content
> > > ===============
> > >
> > > - Pulsar API
> > > (https://pulsar.apache.org/docs/next/pulsar-api-overview/)
> > >
> > > - Pulsar admin API
> > > → Overview (https://pulsar.apache.org/docs/next/admin-api-overview/)
> > > → Use cases (https://pulsar.apache.org/docs/next/admin-api-use-cases/）
> > > → Features (https://pulsar.apache.org/docs/next/admin-api-features/)
> > > → Tools (https://pulsar.apache.org/docs/next/admin-api-tools/)
> > > → Get started (
> > https://pulsar.apache.org/docs/next/admin-api-get-started/)
> > >
> > > - Pulsar client API
> > > (https://pulsar.apache.org/docs/next/client-api-overview/)
> > >
> > > - Pulsar CLI
> > > → pulsar-admin: Get started (
> > > https://pulsar.apache.org/docs/next/get-started-pulsar-admin/)
> > >
> > > Enjoy reading!
> > > Here [1] are related doc PRs.
> > > We'll add more docs on these topics in the near future.
> > > Feel free to leave your suggestions, TIA!
> > >
> > > ===============
> > > Acknowledgment
> > > ===============
> > >
> > > @hangc0276 Huge shout out to you for providing technical input and
> > > guidance!
> > >
> > > @BewareMyPower @horizonzy A big thank you for your technical support!
> > >
> > > ===============
> > >
> > > [1]
> > > - https://github.com/apache/pulsar-site/pull/462
> > > - https://github.com/apache/pulsar-site/pull/403
> > > - https://github.com/apache/pulsar/pull/19002
> > > - https://github.com/apache/pulsar/pull/18680
> > >
> > > Yu
> > >
> >
>
Re: New Pulsar docs (API + CLI) are available!
Posted by Asaf Mesika <as...@gmail.com>.
Good work - this makes the API documentation better for end users and less
confusing.
One small note: https://pulsar.apache.org/docs/next/admin-api-tutorial/ - I
didn't find a tutorial there, mainly setup instructions.
On Fri, Mar 17, 2023 at 11:13 AM Max Xu <ma...@gmail.com> wrote:
> Yu , Thanks for driving this. It looks great!
>
> Best,
> Max Xu
>
>
> On Thu, Mar 16, 2023 at 8:06 PM Yu <li...@apache.org> wrote:
>
> > Hi community,
> >
> > To improve the developer experience and take Pulsar content to the next
> > level, recently we (+@hangc0276) have added some new docs as below.
> >
> > ===============
> > Fresh New Content
> > ===============
> >
> > - Pulsar API
> > (https://pulsar.apache.org/docs/next/pulsar-api-overview/)
> >
> > - Pulsar admin API
> > → Overview (https://pulsar.apache.org/docs/next/admin-api-overview/)
> > → Use cases (https://pulsar.apache.org/docs/next/admin-api-use-cases/）
> > → Features (https://pulsar.apache.org/docs/next/admin-api-features/)
> > → Tools (https://pulsar.apache.org/docs/next/admin-api-tools/)
> > → Get started (
> https://pulsar.apache.org/docs/next/admin-api-get-started/)
> >
> > - Pulsar client API
> > (https://pulsar.apache.org/docs/next/client-api-overview/)
> >
> > - Pulsar CLI
> > → pulsar-admin: Get started (
> > https://pulsar.apache.org/docs/next/get-started-pulsar-admin/)
> >
> > Enjoy reading!
> > Here [1] are related doc PRs.
> > We'll add more docs on these topics in the near future.
> > Feel free to leave your suggestions, TIA!
> >
> > ===============
> > Acknowledgment
> > ===============
> >
> > @hangc0276 Huge shout out to you for providing technical input and
> > guidance!
> >
> > @BewareMyPower @horizonzy A big thank you for your technical support!
> >
> > ===============
> >
> > [1]
> > - https://github.com/apache/pulsar-site/pull/462
> > - https://github.com/apache/pulsar-site/pull/403
> > - https://github.com/apache/pulsar/pull/19002
> > - https://github.com/apache/pulsar/pull/18680
> >
> > Yu
> >
>
Re: New Pulsar docs (API + CLI) are available!
Posted by Max Xu <ma...@gmail.com>.
Yu , Thanks for driving this. It looks great!
Best,
Max Xu
On Thu, Mar 16, 2023 at 8:06 PM Yu <li...@apache.org> wrote:
> Hi community,
>
> To improve the developer experience and take Pulsar content to the next
> level, recently we (+@hangc0276) have added some new docs as below.
>
> ===============
> Fresh New Content
> ===============
>
> - Pulsar API
> (https://pulsar.apache.org/docs/next/pulsar-api-overview/)
>
> - Pulsar admin API
> → Overview (https://pulsar.apache.org/docs/next/admin-api-overview/)
> → Use cases (https://pulsar.apache.org/docs/next/admin-api-use-cases/）
> → Features (https://pulsar.apache.org/docs/next/admin-api-features/)
> → Tools (https://pulsar.apache.org/docs/next/admin-api-tools/)
> → Get started (https://pulsar.apache.org/docs/next/admin-api-get-started/)
>
> - Pulsar client API
> (https://pulsar.apache.org/docs/next/client-api-overview/)
>
> - Pulsar CLI
> → pulsar-admin: Get started (
> https://pulsar.apache.org/docs/next/get-started-pulsar-admin/)
>
> Enjoy reading!
> Here [1] are related doc PRs.
> We'll add more docs on these topics in the near future.
> Feel free to leave your suggestions, TIA!
>
> ===============
> Acknowledgment
> ===============
>
> @hangc0276 Huge shout out to you for providing technical input and
> guidance!
>
> @BewareMyPower @horizonzy A big thank you for your technical support!
>
> ===============
>
> [1]
> - https://github.com/apache/pulsar-site/pull/462
> - https://github.com/apache/pulsar-site/pull/403
> - https://github.com/apache/pulsar/pull/19002
> - https://github.com/apache/pulsar/pull/18680
>
> Yu
>