You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@rocketmq.apache.org by Xin Wang <da...@gmail.com> on 2017/03/09 01:34:54 UTC
Suggestions
Hi devs,
Here are some suggestions about documents in rocketmq-site.
1. "Versioned" documents.
2. Some important parts are missing in documents:
APIs, as well as examples (Producer, Consumer)
Configurations (Broker, NameServer, Producer, Consumer)
Thanks,
Xin Wang (vesense)
Re: Suggestions
Posted by Xin Wang <da...@gmail.com>.
Thanks for the responses. And I have another suggestion: As rocketmq
beginners, we may need more details about "pull" and "push" Consumer mode.
We/beginners must understand the concept clearly before deciding which one
to choose. We'd better add more explanations at some place(CONCEPT/FAQ page
can be an option).
- Xin
2017-03-10 11:50 GMT+08:00 Roman Shtykh <rs...@yahoo.com.invalid>:
> In addition to what Xin mentioned, a figure of all components with their
> role descriptions and cluster configuration modes would be valuable for any
> developer who gets interested in RocketMQ. That's what I really needed to
> understand the architecture when I started with it.
> Roman
>
>
> On Friday, March 10, 2017 12:36 PM, yukon <yu...@apache.org> wrote:
>
>
> Hi Xin,
>
> Thanks for your suggestions, the documents are improving day by day, and
> "Versioned" documents are necessary, we will add these when client APIs are
> changed.
>
> Regards,
> yukon
>
> On Thu, Mar 9, 2017 at 9:34 AM, Xin Wang <da...@gmail.com> wrote:
>
> > Hi devs,
> >
> > Here are some suggestions about documents in rocketmq-site.
> >
> > 1. "Versioned" documents.
> > 2. Some important parts are missing in documents:
> > APIs, as well as examples (Producer, Consumer)
> > Configurations (Broker, NameServer, Producer, Consumer)
> >
> > Thanks,
> >
> > Xin Wang (vesense)
> >
>
>
>
>
Re: Suggestions
Posted by Roman Shtykh <rs...@yahoo.com.INVALID>.
In addition to what Xin mentioned, a figure of all components with their role descriptions and cluster configuration modes would be valuable for any developer who gets interested in RocketMQ. That's what I really needed to understand the architecture when I started with it.
Roman
On Friday, March 10, 2017 12:36 PM, yukon <yu...@apache.org> wrote:
Hi Xin,
Thanks for your suggestions, the documents are improving day by day, and
"Versioned" documents are necessary, we will add these when client APIs are
changed.
Regards,
yukon
On Thu, Mar 9, 2017 at 9:34 AM, Xin Wang <da...@gmail.com> wrote:
> Hi devs,
>
> Here are some suggestions about documents in rocketmq-site.
>
> 1. "Versioned" documents.
> 2. Some important parts are missing in documents:
> APIs, as well as examples (Producer, Consumer)
> Configurations (Broker, NameServer, Producer, Consumer)
>
> Thanks,
>
> Xin Wang (vesense)
>
Re: Suggestions
Posted by yukon <yu...@apache.org>.
Hi Xin,
Thanks for your suggestions, the documents are improving day by day, and
"Versioned" documents are necessary, we will add these when client APIs are
changed.
Regards,
yukon
On Thu, Mar 9, 2017 at 9:34 AM, Xin Wang <da...@gmail.com> wrote:
> Hi devs,
>
> Here are some suggestions about documents in rocketmq-site.
>
> 1. "Versioned" documents.
> 2. Some important parts are missing in documents:
> APIs, as well as examples (Producer, Consumer)
> Configurations (Broker, NameServer, Producer, Consumer)
>
> Thanks,
>
> Xin Wang (vesense)
>
Re: Suggestions
Posted by yukon <yu...@apache.org>.
agree, we could try it.
On Mon, Mar 13, 2017 at 7:56 PM, Zhanhui Li <li...@gmail.com> wrote:
> Git book looks pretty nice, guess we may use it to organize and layout.
>
> > 在 2017年3月13日，下午6:56，Willem Jiang <wi...@gmail.com> 写道：
> >
> > Can we use gitbook[1] to write the user guide?
> > It's quite easy to make the document "versioned".
> >
> > [1]https://github.com/GitbookIO/gitbook
> >
> >
> > Willem Jiang
> >
> > Blog: http://willemjiang.blogspot.com (English)
> > http://jnn.iteye.com (Chinese)
> > Twitter: willemjiang
> > Weibo: 姜宁willem
> >
> > On Thu, Mar 9, 2017 at 9:34 AM, Xin Wang <da...@gmail.com> wrote:
> >
> >> Hi devs,
> >>
> >> Here are some suggestions about documents in rocketmq-site.
> >>
> >> 1. "Versioned" documents.
> >> 2. Some important parts are missing in documents:
> >> APIs, as well as examples (Producer, Consumer)
> >> Configurations (Broker, NameServer, Producer, Consumer)
> >>
> >> Thanks,
> >>
> >> Xin Wang (vesense)
> >>
>
>
Re: Suggestions
Posted by Zhanhui Li <li...@gmail.com>.
Git book looks pretty nice, guess we may use it to organize and layout.
> 在 2017年3月13日，下午6:56，Willem Jiang <wi...@gmail.com> 写道：
>
> Can we use gitbook[1] to write the user guide?
> It's quite easy to make the document "versioned".
>
> [1]https://github.com/GitbookIO/gitbook
>
>
> Willem Jiang
>
> Blog: http://willemjiang.blogspot.com (English)
> http://jnn.iteye.com (Chinese)
> Twitter: willemjiang
> Weibo: 姜宁willem
>
> On Thu, Mar 9, 2017 at 9:34 AM, Xin Wang <da...@gmail.com> wrote:
>
>> Hi devs,
>>
>> Here are some suggestions about documents in rocketmq-site.
>>
>> 1. "Versioned" documents.
>> 2. Some important parts are missing in documents:
>> APIs, as well as examples (Producer, Consumer)
>> Configurations (Broker, NameServer, Producer, Consumer)
>>
>> Thanks,
>>
>> Xin Wang (vesense)
>>
Re: Suggestions
Posted by Willem Jiang <wi...@gmail.com>.
Can we use gitbook[1] to write the user guide?
It's quite easy to make the document "versioned".
[1]https://github.com/GitbookIO/gitbook
Willem Jiang
Blog: http://willemjiang.blogspot.com (English)
http://jnn.iteye.com (Chinese)
Twitter: willemjiang
Weibo: 姜宁willem
On Thu, Mar 9, 2017 at 9:34 AM, Xin Wang <da...@gmail.com> wrote:
> Hi devs,
>
> Here are some suggestions about documents in rocketmq-site.
>
> 1. "Versioned" documents.
> 2. Some important parts are missing in documents:
> APIs, as well as examples (Producer, Consumer)
> Configurations (Broker, NameServer, Producer, Consumer)
>
> Thanks,
>
> Xin Wang (vesense)
>