You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@dubbo.apache.org by Huxing Zhang <hu...@apache.org> on 2019/03/01 02:37:51 UTC

Re: [Discussion] Provide different documentation for each release

+1 to have each release documented.

At least we should have a blog post for each release introducing the
major changes.

On Thu, Feb 28, 2019 at 11:09 PM Taosheng Wei <ts...@apache.org> wrote:
>
> Hi Community,
> Now the documentations of dubbo do not associate each release version.
> I find some projects, like spring, have a complete documentation for each
> stable release. Maybe most contents of a document of each release are
> identical, but if the features are added or changed, or api has been
> changed, the document can provide the latest guide to users.
>
> So I think we can follow projects like spring, to provide a complete
> documentation for each release. Maybe we do not need to patch all the
> releases that have been not latest. We can provide a new complete
> documentation from a future release. And we can continue providing complete
> documentations for releases after the first release which have a complete
> one.
>
> What's your opinions?
>
> Best regards,
> Taosheng



-- 
Best Regards!
Huxing

Re: [Discussion] Provide different documentation for each release

Posted by "Taosheng, Wei" <we...@foxmail.com>.
Yes, we can firstly add a side bar called "New features of each release", and this bar will have articles for releases that they are one to one corresponded.




------------------ Original ------------------
From: Huxing Zhang <hu...@apache.org>
Date: Fri,Mar 1,2019 10:38 AM
To: dev <de...@dubbo.apache.org>
Subject: Re: [Discussion] Provide different documentation for each release



+1 to have each release documented.

At least we should have a blog post for each release introducing the
major changes.

On Thu, Feb 28, 2019 at 11:09 PM Taosheng Wei <ts...@apache.org> wrote:
>
> Hi Community,
> Now the documentations of dubbo do not associate each release version.
> I find some projects, like spring, have a complete documentation for each
> stable release. Maybe most contents of a document of each release are
> identical, but if the features are added or changed, or api has been
> changed, the document can provide the latest guide to users.
>
> So I think we can follow projects like spring, to provide a complete
> documentation for each release. Maybe we do not need to patch all the
> releases that have been not latest. We can provide a new complete
> documentation from a future release. And we can continue providing complete
> documentations for releases after the first release which have a complete
> one.
>
> What's your opinions?
>
> Best regards,
> Taosheng



-- 
Best Regards!
Huxing

Re:Re: [Discussion] Provide different documentation for each release

Posted by KimmKing <ki...@apache.org>.
+1 good idea








+1  good idea
At 2019-03-01 10:37:51, "Huxing Zhang" <hu...@apache.org> wrote:
>+1 to have each release documented.
>
>At least we should have a blog post for each release introducing the
>major changes.
>
>On Thu, Feb 28, 2019 at 11:09 PM Taosheng Wei <ts...@apache.org> wrote:
>>
>> Hi Community,
>> Now the documentations of dubbo do not associate each release version.
>> I find some projects, like spring, have a complete documentation for each
>> stable release. Maybe most contents of a document of each release are
>> identical, but if the features are added or changed, or api has been
>> changed, the document can provide the latest guide to users.
>>
>> So I think we can follow projects like spring, to provide a complete
>> documentation for each release. Maybe we do not need to patch all the
>> releases that have been not latest. We can provide a new complete
>> documentation from a future release. And we can continue providing complete
>> documentations for releases after the first release which have a complete
>> one.
>>
>> What's your opinions?
>>
>> Best regards,
>> Taosheng
>
>
>
>-- 
>Best Regards!
>Huxing