Re: [DISCUSSION] [Website] Reorganize official website documents

2019-11-27 Thread victor chan 
This is Chinese,
文档
├── 入门指引（仅做索引和学习流程指导）
│   ├── 平台安装
│   ├── 入门项目
│   ├── 进阶项目
│   └── 解决方案
│
├── 项目A
│   ├── 项目介绍
│   │   ├── 是什么、解决了什么
│   │   ├── 架构解析
│   │   └── 功能简介
│   ├── 快速入门（仅做最简单的启动介绍）
│   ├── 功能详解 （结合示例）
│   │   ├── 从零创建
│   │   ├── 功能1
│   │   ├── 功能2
│   │   └── 功能...
│   ├── API/配置查询手册
│   ├── 效率工具 （结合实际）
│   │   ├── 工具A
│   │   ├── 工具B
│   │   └── 工具...
│   ├── 经验参考 （按实际输出，以下为假设内容）
│   │   ├── 性能测试与调优
│   │   ├── 生产环境建议（功能启用、升级方案等）
│   │   ├── 故障排查
│   │   └── 常见问题
│   ├── 开发指南
│   │   ├── 源码构建
│   │   ├── 模块设计
│   │   ├── 模块A源码解析
│   │   ├── 模块B源码解析
│   │   ├── 模块...源码解析
│   │   ├── 编码规范约定
│   │   └── 测试用例指导
│   └── 运维指南
│   ├── 管理页面介绍
│   ├── 功能A
│   ├── 功能B
│   └── 功能...
│
└── 项目...
└── ...

victor chan  于2019年11月28日周四 下午2:26写道：

> Based on feedback from previous users, I planned a document improvement
> structure. like this,
>
> Documentation
> ├── Getting Started Guide (for indexing and learning process guidance only)
> │   ├── Platform installation
> │   ├── Entry project
> │   ├── Advanced Project
> │   └── Solutions
> │
> ├── Project A
> │   ├── Project introduction
> │   │   ├── What is it, what is solved
> │   │   ├── Architecture analysis
> │   │   └── Function introduction
> │   ├── Quick start (only the simplest introduction)
> │   ├── Detailed function (combination example)
> │   │   ├── Create from zero
> │   │   ├── Function 1
> │   │   ├── Function 2
> │   │   └── Function ...
> │   ├── API / configuration query manual
> │   ├── Efficiency tool (combined with reality)
> │   │   ├── Tool A
> │   │   ├── Tool B
> │   │   └── Tool ...
> │   ├── Experience reference (According to actual output, the following is
> hypothetical content)
> │   │   ├── Performance testing and tuning
> │   │   ├── Suggestion for the production environment (function
> enablement, upgrade plan, etc.)
> │   │   ├── Troubleshooting
> │   │   └── FAQ
> │   ├── Development Guide
> │   │   ├── Build from source code
> │   │   ├── Module design
> │   │   ├── Module A source code analysis
> │   │   ├── Module B source code analysis
> │   │   ├── Module ... source code analysis
> │   │   ├── Coding conventions
> │   │   └── Test case guidance
> │   └── Operation and Maintenance Guide
> │   ├──  Management page introduction
> │   ├── Function A
> │   ├── Function B
> │   └── Function ...
> │
> └── Project ...
> └── ...
>
> Do you have any thoughts?
>

[DISCUSSION] [Website] Reorganize official website documents

2019-11-27 Thread victor chan 
Based on feedback from previous users, I planned a document improvement
structure. like this,

Documentation
├── Getting Started Guide (for indexing and learning process guidance only)
│   ├── Platform installation
│   ├── Entry project
│   ├── Advanced Project
│   └── Solutions
│
├── Project A
│   ├── Project introduction
│   │   ├── What is it, what is solved
│   │   ├── Architecture analysis
│   │   └── Function introduction
│   ├── Quick start (only the simplest introduction)
│   ├── Detailed function (combination example)
│   │   ├── Create from zero
│   │   ├── Function 1
│   │   ├── Function 2
│   │   └── Function ...
│   ├── API / configuration query manual
│   ├── Efficiency tool (combined with reality)
│   │   ├── Tool A
│   │   ├── Tool B
│   │   └── Tool ...
│   ├── Experience reference (According to actual output, the following is
hypothetical content)
│   │   ├── Performance testing and tuning
│   │   ├── Suggestion for the production environment (function enablement,
upgrade plan, etc.)
│   │   ├── Troubleshooting
│   │   └── FAQ
│   ├── Development Guide
│   │   ├── Build from source code
│   │   ├── Module design
│   │   ├── Module A source code analysis
│   │   ├── Module B source code analysis
│   │   ├── Module ... source code analysis
│   │   ├── Coding conventions
│   │   └── Test case guidance
│   └── Operation and Maintenance Guide
│   ├──  Management page introduction
│   ├── Function A
│   ├── Function B
│   └── Function ...
│
└── Project ...
└── ...

Do you have any thoughts?

Re: [DISCUSSION][Toolkit] Prepare to release 0.2.0

2019-11-27 Thread Bin Ma 
Hi Daniel,

I will start an issue to describe them soon.


Daniel Qian  于 2019年11月27日周三 17:01写道：

> Hi Ma, would you like to point out which part doesn't match?
>
> Bin Ma  于2019年11月27日周三 下午2:53写道：
> >
> > I checked servicecomb-toolkit README[1] and found that it is not match
> with
> > the latest code.
> > I think we can start a vote for 0.2.0 release after the README is
> updated.
> >
> > [1]  
> > https://github.com/apache/servicecomb-toolkit/blob/master/README.md
> >
> https://github.com/apache/servicecomb-toolkit/blob/master/README-ZH.md
> >
> >
> >
> > Wishes & Regards
> > ---
> > Mabin
> >
> >
> >
> >
> > Shuo Chen  于2019年11月26日周二 下午3:54写道：
> >
> > > +1 looking forward to  corresponding articles too
> > >
> > > Daniel Qian  于2019年11月26日周二 下午3:34写道：
> > >
> > > > +1 looking forward to toolkit 0.2.0
> > > >
> > > > sen sun  于2019年11月26日周二 上午11:16写道：
> > > > >
> > > > > Hi toolkit team,
> > > > >
> > > > > We have developed many new features, I think it's time to release
> 0.2.0
> > > > > Our new features are as follows:
> > > > >  * oas-validator for compliance check
> > > > >  * oas-validator for compatibility check
> > > > >  * new oas-generator for generating contract from code
> > > > >  * support openapi v3
> > > > >  * support generate springcloud microservice project
> > > > >  * etc ...  I may not list enough, I hope everyone can add what you
> > > know
> > > > >
> > > > > What do you think about releasing 0.2.0?
> > > > >
> > > > > If everyone agrees to release a new version, we may start to do
> some
> > > > work:
> > > > >  * make sure the license is ok
> > > > >  * make sure our features are complete
> > > > >  * make sure our tests are complete
> > > > >  * etc ... I may not list enough, I hope everyone can add what you
> know
> > > > >
> > > > > If not, maybe we need to discuss what needs to be done to get it to
> > > > release
> > > > >
> > > > >
> > > > > And I attach the information for reference. This is the roadmap
> for the
> > > > > previous community discussions：
> > > > >  *
> > > > >
> > > >
> > >
> https://lists.apache.org/thread.html/5048ca4aa778b13952cefcd32ec25be24eb38eb8424f24c80340183b@%3Cdev.servicecomb.apache.org%3E
> > > > >
> > > > > Any ideas are welcome
> > > >
> > > >
> > > >
> > > > --
> > > > Daniel Qian
> > > > Apache Committer(chanjarster)
> > > > blog：https://chanjarster.github.io
> > > > github：https://github.com/chanjarster
> > > > segmentfault: https://segmentfault.com/u/chanjarster
> > > >
> > >
>
>
>
> --
> Daniel Qian
> Apache Committer(chanjarster)
> blog：https://chanjarster.github.io
> github：https://github.com/chanjarster
> segmentfault: https://segmentfault.com/u/chanjarster
>

Re: [DISCUSSION][Toolkit] Prepare to release 0.2.0

2019-11-27 Thread Daniel Qian 
Hi Ma, would you like to point out which part doesn't match?

Bin Ma  于2019年11月27日周三 下午2:53写道：
>
> I checked servicecomb-toolkit README[1] and found that it is not match with
> the latest code.
> I think we can start a vote for 0.2.0 release after the README is updated.
>
> [1]  
> https://github.com/apache/servicecomb-toolkit/blob/master/README.md
>  https://github.com/apache/servicecomb-toolkit/blob/master/README-ZH.md
>
>
>
> Wishes & Regards
> ---
> Mabin
>
>
>
>
> Shuo Chen  于2019年11月26日周二 下午3:54写道：
>
> > +1 looking forward to  corresponding articles too
> >
> > Daniel Qian  于2019年11月26日周二 下午3:34写道：
> >
> > > +1 looking forward to toolkit 0.2.0
> > >
> > > sen sun  于2019年11月26日周二 上午11:16写道：
> > > >
> > > > Hi toolkit team,
> > > >
> > > > We have developed many new features, I think it's time to release 0.2.0
> > > > Our new features are as follows:
> > > >  * oas-validator for compliance check
> > > >  * oas-validator for compatibility check
> > > >  * new oas-generator for generating contract from code
> > > >  * support openapi v3
> > > >  * support generate springcloud microservice project
> > > >  * etc ...  I may not list enough, I hope everyone can add what you
> > know
> > > >
> > > > What do you think about releasing 0.2.0?
> > > >
> > > > If everyone agrees to release a new version, we may start to do some
> > > work:
> > > >  * make sure the license is ok
> > > >  * make sure our features are complete
> > > >  * make sure our tests are complete
> > > >  * etc ... I may not list enough, I hope everyone can add what you know
> > > >
> > > > If not, maybe we need to discuss what needs to be done to get it to
> > > release
> > > >
> > > >
> > > > And I attach the information for reference. This is the roadmap for the
> > > > previous community discussions：
> > > >  *
> > > >
> > >
> > https://lists.apache.org/thread.html/5048ca4aa778b13952cefcd32ec25be24eb38eb8424f24c80340183b@%3Cdev.servicecomb.apache.org%3E
> > > >
> > > > Any ideas are welcome
> > >
> > >
> > >
> > > --
> > > Daniel Qian
> > > Apache Committer(chanjarster)
> > > blog：https://chanjarster.github.io
> > > github：https://github.com/chanjarster
> > > segmentfault: https://segmentfault.com/u/chanjarster
> > >
> >



-- 
Daniel Qian
Apache Committer(chanjarster)
blog：https://chanjarster.github.io
github：https://github.com/chanjarster
segmentfault: https://segmentfault.com/u/chanjarster