We are keeping in thinking a way to better guide the first start users. Maybe a working project is very good start point. However, quick start to tell the basics is also very important. Inspired by working project, I write a quick start to let users download examples or using archetypes recently provided. Please check https://huaweicse.github.io/servicecomb-java-chassis-doc/zh_CN/start/first-sample.html
We are now working on better ServiceComb-java-chassis documents now, and this link is the preview version. ------------------ ???????? ------------------ ??????: "Zen Lin"<[email protected]>; ????????: 2018??5??10??(??????) ????7:39 ??????: "dev"<[email protected]>; ????: Re: [Discussion] Improve documents of serviceComb Hi kirin, Thanks. I think we should figure out what the users want when they want to reading the quickstart and userguide. What liubao doing is to output a comprehensive user guide like Api-reference book, and the community lacks of documentation focused solely on helping users get started. I think it is quite important to supplement this deficiency, so is our goal should be focused on the following 3 key points? 1. One simplest sample to show easily Using ServiceComb by one-click. 2. One small sample to show users can make there apps easily have basic service governance capabilities with ServiceComb. 3. A simple sample corresponding to a functionality of ServiceComb, like what you mentioned like Spring. Anyway, you can also finding some place on the website to list and brief introduce the medium-sized code case, like company,Weather forecast??CRM. Best Regards, --- Zen Lin [email protected] Focused on Micro Service and Apache ServiceComb 2018-05-10 17:50 GMT+08:00 kirin wang <[email protected]>: > Hi Community?? > > Recently we have recieved some feedback from our user , that our > documents are not enough quick&clear and sometimes it still causes some > error. May be we should discuss how to improve it together. > > Take our "Quick Start" as an example[1]: > 1. Codes or configs (like "pom.xml" ) are fragment , not the whole file > , some beginners cannot fully understand how to make it work . > 2. We introduced several features like load balance, circuit break etc. > Currently there are all "under bmi" , which means if one wants to simply > test one of our feature, he must learn from start. Here we may reference > the docs in spring.io[2] , every feature in it can run separately and > quickly. > 3. Now we already have "scaffold" aims to make developing microservices > via serviceComb more quickly??may be it's necessary to consider integrate > ??scaffold?? with current "Quick Start" > > > > > > [1] http://servicecomb.incubator.apache.org/docs/quick-start/ > [2] https://spring.io/guides >
