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/05/07 13:08:15 UTC
回复： About java-chassis documents improvements
I created a project https://github.com/huaweicse/servicecomb-java-chassis-doc
to migrate CSE docs to servicecomb.
There are now quite a lot of things to do, major part listed below:
1. project description change to ServiceComb-java-chassis and remove CSE key words
2. File names include CSE need to be renamed
3. Unrelated contents and code imports need to be changed
4. And translations...
5. Merge contents of servicecomb.io
This is a huge work, any contributions is appreciated. We can use this site for quit a while to see if we can achieve our final goals.
------------------ 原始邮件 ------------------
发件人: "Zen Lin"<ze...@gmail.com>;
发送时间: 2018年5月7日(星期一) 下午5:58
收件人: "dev"<de...@servicecomb.apache.org>;
主题: Re: About java-chassis documents improvements
Hi Liubao,
I think It could be very nice of you to move the comprehensive of CSE
version to Apache ServiceComb.
To the current users, most of them are Chinese, of course, they need doc in
Chinese,
As a opensource project, I think it is better to try our best to translate
the doc to English,
As a Apache incubating project, I think it will be better if you can remove
CSE related contents before you put it out.
Therefore, to my opinion, how about doing this job as the following steps,
1. Convert the userguide content on website to a gitbook.
2. Link the gitbook to the entry of userguide of website.
3. Remove CSE related content in original CSE document step by step, once
you have done one part, you can create PR to commit to the gitbook linked
to the userguide entry of website .
4. Anyone is interested in translating the doc can ceate PR to commit to
the English doc linked to the userguide entry of website.
Best Regards,
---
Zen Lin
zenlintechnofreak@gmail.com
Focused on Micro Service and Apache ServiceComb
2018-05-07 17:18 GMT+08:00 Willem Jiang <wi...@gmail.com>:
> Hi Liubao,
>
> It's quite important that we have a good document of user guide, it could
> save us lots of time to answer the question from user.
> As ASF is vendor neutral, we need to remove the CSE related contents before
> contribute the ServiceComb Java Chassis.
> I think we could link the gitbook in the servicecomb website and add a page
> of how to update the document.
>
> Current there is only Chinese document, we need to provide the English
> version at the same time.
>
>
> Willem Jiang
>
> Blog: http://willemjiang.blogspot.com (English)
> http://jnn.iteye.com (Chinese)
> Twitter: willemjiang
> Weibo: 姜宁willem
>
> On Mon, May 7, 2018 at 3:51 PM, bismy <bi...@qq.com> wrote:
>
> > Hi all,
> >
> >
> > ServiceComb-java-chassis documents now is developed in
> > https://github.com/apache/incubator-servicecomb-website and hosted in
> > http://servicecomb.incubator.apache.org. And we have
> > a comprehensive docs originally for Huawei CSE and want to contribute
> them
> > to ServiceComb-java-chassis.
> >
> >
> > Here are some steps I want to do this:
> > 1. Adding the docs to https://github.com/apache/
> > incubator-servicecomb-java-chassis, create a new folder 'docs'
> > 2. Then we can view the documents though github.io.
> > I add an project example to demonstrate these two steps:
> > https://liubao68.github.io/ReadTheDocDemo/ and the CSE contents also in
> > the project.
> > The documents is based on gitbook and can be easily edited and viewed.
> >
> >
> > Future work:
> > 1. remove all contents not fit for ServiceComb
> > 2. Merge https://github.com/apache/incubator-servicecomb-website
> > java-chassis related contents. And this website will focus on general
> > problems with ServiceComb, blocks and FAQs, java-chassis
> > only contents will be removed.
> >
> >
> > This is a quick proposal, and We can do this after "remove all contents
> > not fit for ServiceComb" is done. If wait for this, we need to create a
> > temporary project to hosting all documents.
> >
> >
> > Any ideas?
> >
> >
> > Regards.
>
Re: About java-chassis documents improvements
Posted by Zen Lin <ze...@gmail.com>.
Yeah, agree with Willem.
If we have decomposed the task into smaller one which is a small and
complete story, maybe I can find someone in the community or interested in
doc work to help the finishing the job.
For example, I can find someone interested in translation to help translate
the doc.
Best Regards,
---
Zen Lin
zenlintechnofreak@gmail.com
Focused on Micro Service and Apache ServiceComb
2018-05-08 6:36 GMT+08:00 Willem Jiang <wi...@gmail.com>:
> Document is a good start point for the people to get to know the project.
> We definitely need lots of help from the community.
> Let's start it now, break the task into smaller one and ask help in the
> community.
>
>
> Willem Jiang
>
> Blog: http://willemjiang.blogspot.com (English)
> http://jnn.iteye.com (Chinese)
> Twitter: willemjiang
> Weibo: 姜宁willem
>
> On Mon, May 7, 2018 at 9:08 PM, bismy <bi...@qq.com> wrote:
>
> > I created a project https://github.com/huaweicse/
> > servicecomb-java-chassis-doc
> > to migrate CSE docs to servicecomb.
> >
> >
> > There are now quite a lot of things to do, major part listed below:
> > 1. project description change to ServiceComb-java-chassis and remove CSE
> > key words
> > 2. File names include CSE need to be renamed
> > 3. Unrelated contents and code imports need to be changed
> > 4. And translations...
> > 5. Merge contents of servicecomb.io
> >
> >
> > This is a huge work, any contributions is appreciated. We can use this
> > site for quit a while to see if we can achieve our final goals.
> >
> >
> >
> >
> > ------------------ 原始邮件 ------------------
> > 发件人: "Zen Lin"<ze...@gmail.com>;
> > 发送时间: 2018年5月7日(星期一) 下午5:58
> > 收件人: "dev"<de...@servicecomb.apache.org>;
> >
> > 主题: Re: About java-chassis documents improvements
> >
> >
> >
> > Hi Liubao,
> >
> > I think It could be very nice of you to move the comprehensive of CSE
> > version to Apache ServiceComb.
> >
> > To the current users, most of them are Chinese, of course, they need doc
> in
> > Chinese,
> > As a opensource project, I think it is better to try our best to
> translate
> > the doc to English,
> > As a Apache incubating project, I think it will be better if you can
> > remove
> > CSE related contents before you put it out.
> >
> >
> > Therefore, to my opinion, how about doing this job as the following
> steps,
> > 1. Convert the userguide content on website to a gitbook.
> > 2. Link the gitbook to the entry of userguide of website.
> > 3. Remove CSE related content in original CSE document step by step,
> once
> > you have done one part, you can create PR to commit to the gitbook linked
> > to the userguide entry of website .
> > 4. Anyone is interested in translating the doc can ceate PR to commit to
> > the English doc linked to the userguide entry of website.
> >
> >
> > Best Regards,
> > ---
> > Zen Lin
> > zenlintechnofreak@gmail.com
> > Focused on Micro Service and Apache ServiceComb
> >
> > 2018-05-07 17:18 GMT+08:00 Willem Jiang <wi...@gmail.com>:
> >
> > > Hi Liubao,
> > >
> > > It's quite important that we have a good document of user guide, it
> > could
> > > save us lots of time to answer the question from user.
> > > As ASF is vendor neutral, we need to remove the CSE related contents
> > before
> > > contribute the ServiceComb Java Chassis.
> > > I think we could link the gitbook in the servicecomb website and add a
> > page
> > > of how to update the document.
> > >
> > > Current there is only Chinese document, we need to provide the English
> > > version at the same time.
> > >
> > >
> > > Willem Jiang
> > >
> > > Blog: http://willemjiang.blogspot.com (English)
> > > http://jnn.iteye.com (Chinese)
> > > Twitter: willemjiang
> > > Weibo: 姜宁willem
> > >
> > > On Mon, May 7, 2018 at 3:51 PM, bismy <bi...@qq.com> wrote:
> > >
> > > > Hi all,
> > > >
> > > >
> > > > ServiceComb-java-chassis documents now is developed in
> > > > https://github.com/apache/incubator-servicecomb-website and hosted
> in
> > > > http://servicecomb.incubator.apache.org. And we have
> > > > a comprehensive docs originally for Huawei CSE and want to contribute
> > > them
> > > > to ServiceComb-java-chassis.
> > > >
> > > >
> > > > Here are some steps I want to do this:
> > > > 1. Adding the docs to https://github.com/apache/
> > > > incubator-servicecomb-java-chassis, create a new folder 'docs'
> > > > 2. Then we can view the documents though github.io.
> > > > I add an project example to demonstrate these two steps:
> > > > https://liubao68.github.io/ReadTheDocDemo/ and the CSE contents
> also
> > in
> > > > the project.
> > > > The documents is based on gitbook and can be easily edited and
> viewed.
> > > >
> > > >
> > > > Future work:
> > > > 1. remove all contents not fit for ServiceComb
> > > > 2. Merge https://github.com/apache/incubator-servicecomb-website
> > > > java-chassis related contents. And this website will focus on general
> > > > problems with ServiceComb, blocks and FAQs, java-chassis
> > > > only contents will be removed.
> > > >
> > > >
> > > > This is a quick proposal, and We can do this after "remove all
> contents
> > > > not fit for ServiceComb" is done. If wait for this, we need to
> create a
> > > > temporary project to hosting all documents.
> > > >
> > > >
> > > > Any ideas?
> > > >
> > > >
> > > > Regards.
> > >
> >
>
Re: About java-chassis documents improvements
Posted by Willem Jiang <wi...@gmail.com>.
Document is a good start point for the people to get to know the project.
We definitely need lots of help from the community.
Let's start it now, break the task into smaller one and ask help in the
community.
Willem Jiang
Blog: http://willemjiang.blogspot.com (English)
http://jnn.iteye.com (Chinese)
Twitter: willemjiang
Weibo: 姜宁willem
On Mon, May 7, 2018 at 9:08 PM, bismy <bi...@qq.com> wrote:
> I created a project https://github.com/huaweicse/
> servicecomb-java-chassis-doc
> to migrate CSE docs to servicecomb.
>
>
> There are now quite a lot of things to do, major part listed below:
> 1. project description change to ServiceComb-java-chassis and remove CSE
> key words
> 2. File names include CSE need to be renamed
> 3. Unrelated contents and code imports need to be changed
> 4. And translations...
> 5. Merge contents of servicecomb.io
>
>
> This is a huge work, any contributions is appreciated. We can use this
> site for quit a while to see if we can achieve our final goals.
>
>
>
>
> ------------------ 原始邮件 ------------------
> 发件人: "Zen Lin"<ze...@gmail.com>;
> 发送时间: 2018年5月7日(星期一) 下午5:58
> 收件人: "dev"<de...@servicecomb.apache.org>;
>
> 主题: Re: About java-chassis documents improvements
>
>
>
> Hi Liubao,
>
> I think It could be very nice of you to move the comprehensive of CSE
> version to Apache ServiceComb.
>
> To the current users, most of them are Chinese, of course, they need doc in
> Chinese,
> As a opensource project, I think it is better to try our best to translate
> the doc to English,
> As a Apache incubating project, I think it will be better if you can
> remove
> CSE related contents before you put it out.
>
>
> Therefore, to my opinion, how about doing this job as the following steps,
> 1. Convert the userguide content on website to a gitbook.
> 2. Link the gitbook to the entry of userguide of website.
> 3. Remove CSE related content in original CSE document step by step, once
> you have done one part, you can create PR to commit to the gitbook linked
> to the userguide entry of website .
> 4. Anyone is interested in translating the doc can ceate PR to commit to
> the English doc linked to the userguide entry of website.
>
>
> Best Regards,
> ---
> Zen Lin
> zenlintechnofreak@gmail.com
> Focused on Micro Service and Apache ServiceComb
>
> 2018-05-07 17:18 GMT+08:00 Willem Jiang <wi...@gmail.com>:
>
> > Hi Liubao,
> >
> > It's quite important that we have a good document of user guide, it
> could
> > save us lots of time to answer the question from user.
> > As ASF is vendor neutral, we need to remove the CSE related contents
> before
> > contribute the ServiceComb Java Chassis.
> > I think we could link the gitbook in the servicecomb website and add a
> page
> > of how to update the document.
> >
> > Current there is only Chinese document, we need to provide the English
> > version at the same time.
> >
> >
> > Willem Jiang
> >
> > Blog: http://willemjiang.blogspot.com (English)
> > http://jnn.iteye.com (Chinese)
> > Twitter: willemjiang
> > Weibo: 姜宁willem
> >
> > On Mon, May 7, 2018 at 3:51 PM, bismy <bi...@qq.com> wrote:
> >
> > > Hi all,
> > >
> > >
> > > ServiceComb-java-chassis documents now is developed in
> > > https://github.com/apache/incubator-servicecomb-website and hosted in
> > > http://servicecomb.incubator.apache.org. And we have
> > > a comprehensive docs originally for Huawei CSE and want to contribute
> > them
> > > to ServiceComb-java-chassis.
> > >
> > >
> > > Here are some steps I want to do this:
> > > 1. Adding the docs to https://github.com/apache/
> > > incubator-servicecomb-java-chassis, create a new folder 'docs'
> > > 2. Then we can view the documents though github.io.
> > > I add an project example to demonstrate these two steps:
> > > https://liubao68.github.io/ReadTheDocDemo/ and the CSE contents also
> in
> > > the project.
> > > The documents is based on gitbook and can be easily edited and viewed.
> > >
> > >
> > > Future work:
> > > 1. remove all contents not fit for ServiceComb
> > > 2. Merge https://github.com/apache/incubator-servicecomb-website
> > > java-chassis related contents. And this website will focus on general
> > > problems with ServiceComb, blocks and FAQs, java-chassis
> > > only contents will be removed.
> > >
> > >
> > > This is a quick proposal, and We can do this after "remove all contents
> > > not fit for ServiceComb" is done. If wait for this, we need to create a
> > > temporary project to hosting all documents.
> > >
> > >
> > > Any ideas?
> > >
> > >
> > > Regards.
> >
>