You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@servicecomb.apache.org by bismy <bi...@qq.com> on 2018/08/08 01:28:22 UTC

回复: [DISCUSS]Add separated selectable version to our documents

Yes. We have to build a release version of doc. And documents can give link to versions. 
e.g.
Java chassis document
latest
1.1.0
1.0.0




------------------ 原始邮件 ------------------
发件人: "willem.jiang"<wi...@gmail.com>;
发送时间: 2018年8月7日(星期二) 晚上10:15
收件人: "dev"<de...@servicecomb.apache.org>;

主题: Re: [DISCUSS]Add separated selectable version to our documents



As the gitbook is using git , we should to the release just as we do for
the source code.

But the challenge is how we host the gitbook, maybe we add the gitbook
build as part of our release process.

Any thought?


Willem Jiang

Twitter: willemjiang
Weibo: 姜宁willem

On Tue, Aug 7, 2018 at 9:30 AM, 郑扬勇 <34...@qq.com> wrote:

> Hi, all:
>    We had implement many new features step by step in each release, so I
> think we also need make docs with separated version like :
>
>  --------------------------------------------
>  User guide                version : 1.0.0 ↓
>  --------------------------------------------
>
>  document content ...
>
>
>
>  --------------------------------------------
>
>    Then user can clear known any feature in which version implemented, Any
> thoughts ?
>
>  Best Regards & Thanks
>  YangYongZheng

回复: [DISCUSS]Add separated selectable version to our documents

Posted by bismy <bi...@qq.com>.
I do not have this yet. And maybe we can provide versioned docs from next release. 




------------------ 原始邮件 ------------------
发件人: "willem.jiang"<wi...@gmail.com>;
发送时间: 2018年8月8日(星期三) 下午3:22
收件人: "dev"<de...@servicecomb.apache.org>;

主题: Re: [DISCUSS]Add separated selectable version to our documents



@bismy,

Can you give us the link for the document?
We can update the website for these versioned documents.


Willem Jiang

Twitter: willemjiang
Weibo: 姜宁willem

On Wed, Aug 8, 2018 at 9:28 AM, bismy <bi...@qq.com> wrote:

> Yes. We have to build a release version of doc. And documents can give
> link to versions.
> e.g.
> Java chassis document
> latest
> 1.1.0
> 1.0.0
>
>
>
>
> ------------------ 原始邮件 ------------------
> 发件人: "willem.jiang"<wi...@gmail.com>;
> 发送时间: 2018年8月7日(星期二) 晚上10:15
> 收件人: "dev"<de...@servicecomb.apache.org>;
>
> 主题: Re: [DISCUSS]Add separated selectable version to our documents
>
>
>
> As the gitbook is using git , we should to the release just as we do for
> the source code.
>
> But the challenge is how we host the gitbook, maybe we add the gitbook
> build as part of our release process.
>
> Any thought?
>
>
> Willem Jiang
>
> Twitter: willemjiang
> Weibo: 姜宁willem
>
> On Tue, Aug 7, 2018 at 9:30 AM, 郑扬勇 <34...@qq.com> wrote:
>
> > Hi, all:
> >    We had implement many new features step by step in each release, so I
> > think we also need make docs with separated version like :
> >
> >  --------------------------------------------
> >  User guide                version : 1.0.0 ↓
> >  --------------------------------------------
> >
> >  document content ...
> >
> >
> >
> >  --------------------------------------------
> >
> >    Then user can clear known any feature in which version implemented,
> Any
> > thoughts ?
> >
> >  Best Regards & Thanks
> >  YangYongZheng
>

回复: [DISCUSS]Add separated selectable version to our documents

Posted by DeanLee <ma...@imlidian.com>.
markdown to pdf, have to install Calibre.It's work.

https://toolchain.gitbook.com/ebook.html 




please give a target path for pdf.

sudo -v && wget -nv -O- https://download.calibre-ebook.com/linux-installer.sh | sudo sh /dev/stdin





------------------ 原始邮件 ------------------
发件人: "Willem Jiang"<wi...@gmail.com>;
发送时间: 2018年8月8日(星期三) 下午4:41
收件人: "dev"<de...@servicecomb.apache.org>;

主题: Re: [DISCUSS]Add separated selectable version to our documents



If we can host the html or pdf which gitbook builds somewhere, it's quit
easy for us to resolve the version issue.
Just like what we did in the release page[1]

[1]http://servicecomb.incubator.apache.org/release/


Willem Jiang

Twitter: willemjiang
Weibo: 姜宁willem

On Wed, Aug 8, 2018 at 4:16 PM, DeanLee <ma...@imlidian.com> wrote:

> hi YangYongZheng,
> About separated version, did anyone do something like that? would you
> please give us an example?
>
> https://github.com/apache/incubator-dubbo-website
> http://dubbo.apache.org/#!/docs/user/quick-start.md?lang=zh-cn
> http://tars.tencent.com/base/help/TARS_quick_start_Java.html
> https://github.com/Tencent/Tars
>
>
>
>
> btw, What's the difference with release note?
> https://github.com/apache/incubator-dubbo/releases
>
>
>
>
>
>
>
> ------------------ 原始邮件 ------------------
> 发件人: "Willem Jiang"<wi...@gmail.com>;
> 发送时间: 2018年8月8日(星期三) 下午3:22
> 收件人: "dev"<de...@servicecomb.apache.org>;
>
> 主题: Re: [DISCUSS]Add separated selectable version to our documents
>
>
>
> @bismy,
>
> Can you give us the link for the document?
> We can update the website for these versioned documents.
>
>
> Willem Jiang
>
> Twitter: willemjiang
> Weibo: 姜宁willem
>
> On Wed, Aug 8, 2018 at 9:28 AM, bismy <bi...@qq.com> wrote:
>
> > Yes. We have to build a release version of doc. And documents can give
> > link to versions.
> > e.g.
> > Java chassis document
> > latest
> > 1.1.0
> > 1.0.0
> >
> >
> >
> >
> > ------------------ 原始邮件 ------------------
> > 发件人: "willem.jiang"<wi...@gmail.com>;
> > 发送时间: 2018年8月7日(星期二) 晚上10:15
> > 收件人: "dev"<de...@servicecomb.apache.org>;
> >
> > 主题: Re: [DISCUSS]Add separated selectable version to our documents
> >
> >
> >
> > As the gitbook is using git , we should to the release just as we do for
> > the source code.
> >
> > But the challenge is how we host the gitbook, maybe we add the gitbook
> > build as part of our release process.
> >
> > Any thought?
> >
> >
> > Willem Jiang
> >
> > Twitter: willemjiang
> > Weibo: 姜宁willem
> >
> > On Tue, Aug 7, 2018 at 9:30 AM, 郑扬勇 <34...@qq.com> wrote:
> >
> > > Hi, all:
> > >    We had implement many new features step by step in each release, so
> I
> > > think we also need make docs with separated version like :
> > >
> > >  --------------------------------------------
> > >  User guide                version : 1.0.0 ↓
> > >  --------------------------------------------
> > >
> > >  document content ...
> > >
> > >
> > >
> > >  --------------------------------------------
> > >
> > >    Then user can clear known any feature in which version implemented,
> > Any
> > > thoughts ?
> > >
> > >  Best Regards & Thanks
> > >  YangYongZheng
> >
>

Re: [DISCUSS]Add separated selectable version to our documents

Posted by Willem Jiang <wi...@gmail.com>.
If we can host the html or pdf which gitbook builds somewhere, it's quit
easy for us to resolve the version issue.
Just like what we did in the release page[1]

[1]http://servicecomb.incubator.apache.org/release/


Willem Jiang

Twitter: willemjiang
Weibo: 姜宁willem

On Wed, Aug 8, 2018 at 4:16 PM, DeanLee <ma...@imlidian.com> wrote:

> hi YangYongZheng,
> About separated version, did anyone do something like that? would you
> please give us an example?
>
> https://github.com/apache/incubator-dubbo-website
> http://dubbo.apache.org/#!/docs/user/quick-start.md?lang=zh-cn
> http://tars.tencent.com/base/help/TARS_quick_start_Java.html
> https://github.com/Tencent/Tars
>
>
>
>
> btw, What's the difference with release note?
> https://github.com/apache/incubator-dubbo/releases
>
>
>
>
>
>
>
> ------------------ 原始邮件 ------------------
> 发件人: "Willem Jiang"<wi...@gmail.com>;
> 发送时间: 2018年8月8日(星期三) 下午3:22
> 收件人: "dev"<de...@servicecomb.apache.org>;
>
> 主题: Re: [DISCUSS]Add separated selectable version to our documents
>
>
>
> @bismy,
>
> Can you give us the link for the document?
> We can update the website for these versioned documents.
>
>
> Willem Jiang
>
> Twitter: willemjiang
> Weibo: 姜宁willem
>
> On Wed, Aug 8, 2018 at 9:28 AM, bismy <bi...@qq.com> wrote:
>
> > Yes. We have to build a release version of doc. And documents can give
> > link to versions.
> > e.g.
> > Java chassis document
> > latest
> > 1.1.0
> > 1.0.0
> >
> >
> >
> >
> > ------------------ 原始邮件 ------------------
> > 发件人: "willem.jiang"<wi...@gmail.com>;
> > 发送时间: 2018年8月7日(星期二) 晚上10:15
> > 收件人: "dev"<de...@servicecomb.apache.org>;
> >
> > 主题: Re: [DISCUSS]Add separated selectable version to our documents
> >
> >
> >
> > As the gitbook is using git , we should to the release just as we do for
> > the source code.
> >
> > But the challenge is how we host the gitbook, maybe we add the gitbook
> > build as part of our release process.
> >
> > Any thought?
> >
> >
> > Willem Jiang
> >
> > Twitter: willemjiang
> > Weibo: 姜宁willem
> >
> > On Tue, Aug 7, 2018 at 9:30 AM, 郑扬勇 <34...@qq.com> wrote:
> >
> > > Hi, all:
> > >    We had implement many new features step by step in each release, so
> I
> > > think we also need make docs with separated version like :
> > >
> > >  --------------------------------------------
> > >  User guide                version : 1.0.0 ↓
> > >  --------------------------------------------
> > >
> > >  document content ...
> > >
> > >
> > >
> > >  --------------------------------------------
> > >
> > >    Then user can clear known any feature in which version implemented,
> > Any
> > > thoughts ?
> > >
> > >  Best Regards & Thanks
> > >  YangYongZheng
> >
>

回复: [DISCUSS]Add separated selectable version to our documents

Posted by DeanLee <ma...@imlidian.com>.
hi YangYongZheng, 
About separated version, did anyone do something like that? would you please give us an example?

https://github.com/apache/incubator-dubbo-website
http://dubbo.apache.org/#!/docs/user/quick-start.md?lang=zh-cn
http://tars.tencent.com/base/help/TARS_quick_start_Java.html
https://github.com/Tencent/Tars




btw, What's the difference with release note?
https://github.com/apache/incubator-dubbo/releases







------------------ 原始邮件 ------------------
发件人: "Willem Jiang"<wi...@gmail.com>;
发送时间: 2018年8月8日(星期三) 下午3:22
收件人: "dev"<de...@servicecomb.apache.org>;

主题: Re: [DISCUSS]Add separated selectable version to our documents



@bismy,

Can you give us the link for the document?
We can update the website for these versioned documents.


Willem Jiang

Twitter: willemjiang
Weibo: 姜宁willem

On Wed, Aug 8, 2018 at 9:28 AM, bismy <bi...@qq.com> wrote:

> Yes. We have to build a release version of doc. And documents can give
> link to versions.
> e.g.
> Java chassis document
> latest
> 1.1.0
> 1.0.0
>
>
>
>
> ------------------ 原始邮件 ------------------
> 发件人: "willem.jiang"<wi...@gmail.com>;
> 发送时间: 2018年8月7日(星期二) 晚上10:15
> 收件人: "dev"<de...@servicecomb.apache.org>;
>
> 主题: Re: [DISCUSS]Add separated selectable version to our documents
>
>
>
> As the gitbook is using git , we should to the release just as we do for
> the source code.
>
> But the challenge is how we host the gitbook, maybe we add the gitbook
> build as part of our release process.
>
> Any thought?
>
>
> Willem Jiang
>
> Twitter: willemjiang
> Weibo: 姜宁willem
>
> On Tue, Aug 7, 2018 at 9:30 AM, 郑扬勇 <34...@qq.com> wrote:
>
> > Hi, all:
> >    We had implement many new features step by step in each release, so I
> > think we also need make docs with separated version like :
> >
> >  --------------------------------------------
> >  User guide                version : 1.0.0 ↓
> >  --------------------------------------------
> >
> >  document content ...
> >
> >
> >
> >  --------------------------------------------
> >
> >    Then user can clear known any feature in which version implemented,
> Any
> > thoughts ?
> >
> >  Best Regards & Thanks
> >  YangYongZheng
>

Re: [DISCUSS]Add separated selectable version to our documents

Posted by Willem Jiang <wi...@gmail.com>.
@bismy,

Can you give us the link for the document?
We can update the website for these versioned documents.


Willem Jiang

Twitter: willemjiang
Weibo: 姜宁willem

On Wed, Aug 8, 2018 at 9:28 AM, bismy <bi...@qq.com> wrote:

> Yes. We have to build a release version of doc. And documents can give
> link to versions.
> e.g.
> Java chassis document
> latest
> 1.1.0
> 1.0.0
>
>
>
>
> ------------------ 原始邮件 ------------------
> 发件人: "willem.jiang"<wi...@gmail.com>;
> 发送时间: 2018年8月7日(星期二) 晚上10:15
> 收件人: "dev"<de...@servicecomb.apache.org>;
>
> 主题: Re: [DISCUSS]Add separated selectable version to our documents
>
>
>
> As the gitbook is using git , we should to the release just as we do for
> the source code.
>
> But the challenge is how we host the gitbook, maybe we add the gitbook
> build as part of our release process.
>
> Any thought?
>
>
> Willem Jiang
>
> Twitter: willemjiang
> Weibo: 姜宁willem
>
> On Tue, Aug 7, 2018 at 9:30 AM, 郑扬勇 <34...@qq.com> wrote:
>
> > Hi, all:
> >    We had implement many new features step by step in each release, so I
> > think we also need make docs with separated version like :
> >
> >  --------------------------------------------
> >  User guide                version : 1.0.0 ↓
> >  --------------------------------------------
> >
> >  document content ...
> >
> >
> >
> >  --------------------------------------------
> >
> >    Then user can clear known any feature in which version implemented,
> Any
> > thoughts ?
> >
> >  Best Regards & Thanks
> >  YangYongZheng
>