[
https://issues.apache.org/jira/browse/SCB-585?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16477196#comment-16477196
]
ASF GitHub Bot commented on SCB-585:
------------------------------------
liubao68 closed pull request #708: [SCB-585]update README.md
URL: https://github.com/apache/incubator-servicecomb-java-chassis/pull/708
This is a PR merged from a forked repository.
As GitHub hides the original diff on merge, it is displayed below for
the sake of provenance:
As this is a foreign pull request (from a fork), the diff is supplied
below (as it won't show otherwise due to GitHub magic):
diff --git a/README.md b/README.md
index f29b1ebf3..c665f2b72 100644
--- a/README.md
+++ b/README.md
@@ -1,74 +1,30 @@
-# Java Chassis
-[](https://travis-ci.org/apache/incubator-servicecomb-java-chassis?branch=master)
[](https://coveralls.io/github/apache/incubator-servicecomb-java-chassis?branch=master)
[](http://search.maven.org/#search%7Cga%7C1%7Corg.apache.servicecomb)
[](https://www.apache.org/licenses/LICENSE-2.0.html)
+## 本项目是servicecomb-java-chassis开发指南。
-Apache ServiceComb (incubating) Java Chassis is a Software Development Kit
(SDK) for rapid development of microservices in Java, providing service
registration, service discovery, dynamic routing, and service management
features
+* [访问地址](https://huaweicse.github.io/servicecomb-java-chassis-doc)
-## Quick Start
+* 编辑
+ 1. Fork本项目代码
+ 2. 方式一：直接编辑docs-source里面的md源码
+ 3. 方式二：下载[GitBook Editor](https://legacy.gitbook.com/editor)编辑
+ 4. 提交PR
-Provider service:
-```java
-import org.apache.servicecomb.*;
-@RpcSchema(schemaId = "helloworld")
-public class HelloWorldProvider implements HelloWorld {
- public String sayHello(String name) {
- return "Hello " + name;
- }
-}
-```
+* 发布
+ 1.
参考[GitBook安装指南](https://github.com/GitbookIO/gitbook/blob/master/docs/setup.md),安装gitbook
+ 2. gitbook build . ./docs
-Consumer service:
-```java
-import org.apache.servicecomb.*;
-@Component
-public class HelloWorldConsumer {
- @RpcReference(microserviceName = "pojo", schemaId = "helloworld")
- private static HelloWorld helloWorld;
+## This project is the servicecomb-java-chassis developers guide
- public static void main(String[] args) {
- helloWorld.sayHello("Tank");
- }
-}
-```
+* [Web address](https://huaweicse.github.io/servicecomb-java-chassis-doc)
-## Documentation
+* Submit PR
+ 1. Fork this project
+ 2. Edit md source file, or
+ 3. Edit using [GitBook Editor](https://legacy.gitbook.com/editor)
+ 4. Submit PR
-Project documentation is available on the [ServiceComb
website][servicecomb-website].
+* Publish
+ 1. see [GitBook installation
guide](https://github.com/GitbookIO/gitbook/blob/master/docs/setup.md)
+ 2. gitbook build . ./docs
-[servicecomb-website]: http://servicecomb.incubator.apache.org/
-## Building
-You don’t need to build from source to use Java Chassis (binaries in apache
nexus ), but if you want to try out the latest and greatest, Java Chassis can
be easily built with the maven. You also need JDK 1.8.
-
- mvn clean install
-
-If you want to build the release kits from the source
-
- mvn clean install -Prelease,distribution
-
-The first build may take a longer than expected as Maven downloads all the
dependencies.
-
-## Automated Testing
-
- To build the docker image and run the integration tests with docker, you can
use maven docker profile
-
- mvn clean install -Pdocker -Pit
-
- If you are using docker machine, please use the following command
-
- mvn clean install -Pdocker -Pit -Pdocker-machine
-
-## Contact
-
-Bugs: [issues](https://issues.apache.org/jira/browse/SCB)
-
-mailing list:
[subscribe](mailto:dev-subscr...@servicecomb.incubator.apache.org)
[dev](https://lists.apache.org/list.html?d...@servicecomb.apache.org)
-
-
-## Contributing
-
-See CONTRIBUTING for details on submitting patches and the contribution
workflow.
-
-## Reporting Issues
-
-See reporting bugs for details about reporting any issues.
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
us...@infra.apache.org
> Add ServiceComb-java-chassis reference guide to project
> -------------------------------------------------------
>
> Key: SCB-585
> URL: https://issues.apache.org/jira/browse/SCB-585
> Project: Apache ServiceComb
> Issue Type: Improvement
> Reporter: liubao
> Assignee: liubao
> Priority: Major
>
--
This message was sent by Atlassian JIRA
(v7.6.3#76005)
