You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@pulsar.apache.org by Jun Ma <mo...@hotmail.com> on 2022/12/08 12:47:03 UTC
[DISCUSS] PIP-228: Refactor the information architecture of Pulsar client docs
Hi, all,
I've created PIP-228 to discuss - Refactor the Information Architecture of Pulsar Client Docs.
Motivation
* Improve the developer experience and help them get started by offering bite-sized basics in the docs.
* Build a solid content structure to make it easier to increment and scale.
* Contribute to Pulsar adoption.
For more details, please read the PIP at https://github.com/apache/pulsar/issues/18822.
I'm looking forward to hearing what you think.
Best,
Jun
Re: [DISCUSS] PIP-228: Refactor the information architecture of Pulsar client docs
Posted by Zike Yang <zi...@apache.org>.
Hi Jun,
Thanks for your explanation. Looks good to me.
BR,
Zike Yang
On Mon, Dec 19, 2022 at 2:35 PM Jun Ma <mo...@hotmail.com> wrote:
>
> Hi Zike,
>
> Thanks for your feedback!
>
> This inaccessible link can be removed because the proposed IA has been shown in the following image. Thanks for pointing it out.
> ________________________________
> From: Zike Yang <zi...@apache.org>
> Sent: Wednesday, December 14, 2022 19:51
> To: dev@pulsar.apache.org <de...@pulsar.apache.org>
> Subject: Re: [DISCUSS] PIP-228: Refactor the information architecture of Pulsar client docs
>
> Hi Jun,
>
> Thanks for your PIP. Overall looks good to me.
>
> > The Client concepts topic does not introduce the basic client concepts and can be enriched with content relocated from other topics. See Proposed IA for more details.
>
> The link of `Proposed IA` doesn't work. Need to grant the access permission.
>
> Thanks,
> Zike Yang
>
> On Thu, Dec 8, 2022 at 8:47 PM Jun Ma <mo...@hotmail.com> wrote:
> >
> > Hi, all,
> >
> > I've created PIP-228 to discuss - Refactor the Information Architecture of Pulsar Client Docs.
> >
> >
> > Motivation
> >
> > * Improve the developer experience and help them get started by offering bite-sized basics in the docs.
> > * Build a solid content structure to make it easier to increment and scale.
> > * Contribute to Pulsar adoption.
> >
> > For more details, please read the PIP at https://github.com/apache/pulsar/issues/18822.
> > I'm looking forward to hearing what you think.
> >
> > Best,
> > Jun
Re: [DISCUSS] PIP-228: Refactor the information architecture of Pulsar client docs
Posted by Jun Ma <mo...@hotmail.com>.
Hi Zike,
Thanks for your feedback!
This inaccessible link can be removed because the proposed IA has been shown in the following image. Thanks for pointing it out.
________________________________
From: Zike Yang <zi...@apache.org>
Sent: Wednesday, December 14, 2022 19:51
To: dev@pulsar.apache.org <de...@pulsar.apache.org>
Subject: Re: [DISCUSS] PIP-228: Refactor the information architecture of Pulsar client docs
Hi Jun,
Thanks for your PIP. Overall looks good to me.
> The Client concepts topic does not introduce the basic client concepts and can be enriched with content relocated from other topics. See Proposed IA for more details.
The link of `Proposed IA` doesn't work. Need to grant the access permission.
Thanks,
Zike Yang
On Thu, Dec 8, 2022 at 8:47 PM Jun Ma <mo...@hotmail.com> wrote:
>
> Hi, all,
>
> I've created PIP-228 to discuss - Refactor the Information Architecture of Pulsar Client Docs.
>
>
> Motivation
>
> * Improve the developer experience and help them get started by offering bite-sized basics in the docs.
> * Build a solid content structure to make it easier to increment and scale.
> * Contribute to Pulsar adoption.
>
> For more details, please read the PIP at https://github.com/apache/pulsar/issues/18822.
> I'm looking forward to hearing what you think.
>
> Best,
> Jun
Re: [DISCUSS] PIP-228: Refactor the information architecture of Pulsar client docs
Posted by Zike Yang <zi...@apache.org>.
Hi Jun,
Thanks for your PIP. Overall looks good to me.
> The Client concepts topic does not introduce the basic client concepts and can be enriched with content relocated from other topics. See Proposed IA for more details.
The link of `Proposed IA` doesn't work. Need to grant the access permission.
Thanks,
Zike Yang
On Thu, Dec 8, 2022 at 8:47 PM Jun Ma <mo...@hotmail.com> wrote:
>
> Hi, all,
>
> I've created PIP-228 to discuss - Refactor the Information Architecture of Pulsar Client Docs.
>
>
> Motivation
>
> * Improve the developer experience and help them get started by offering bite-sized basics in the docs.
> * Build a solid content structure to make it easier to increment and scale.
> * Contribute to Pulsar adoption.
>
> For more details, please read the PIP at https://github.com/apache/pulsar/issues/18822.
> I'm looking forward to hearing what you think.
>
> Best,
> Jun