Merge pull request #92 from fangjian0423/master

Add reference doc module for master branch
2021-06-26 13:25:11 +08:00 · 2018-11-06 17:29:41 +08:00 · 2018-11-06 17:29:41 +08:00 · 110683528a
commit 110683528a
parent cf37d146c2 5c9c29b013
20 changed files with 139 additions and 0 deletions
--- a/pom.xml
+++ b/pom.xml
@ -83,6 +83,7 @@
        <module>spring-cloud-alibaba-nacos-discovery</module>
        <module>spring-cloud-alibaba-examples</module>
        <module>spring-cloud-alibaba-test</module>
+        <module>spring-cloud-alibaba-docs</module>
        <module>spring-cloud-starter-alibaba</module>
        <module>spring-cloud-starter-alicloud</module>
        <module>spring-cloud-alicloud-oss</module>
--- a/spring-cloud-alibaba-docs/pom.xml
+++ b/spring-cloud-alibaba-docs/pom.xml
@ -0,0 +1,54 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
+
+    <parent>
+        <groupId>org.springframework.cloud</groupId>
+        <artifactId>spring-cloud-alibaba</artifactId>
+        <version>0.2.1.BUILD-SNAPSHOT</version>
+    </parent>
+    <modelVersion>4.0.0</modelVersion>
+
+    <groupId>org.springframework.cloud</groupId>
+    <artifactId>spring-cloud-alibaba-docs</artifactId>
+    <name>Spring Cloud Alibaba Documentation</name>
+    <packaging>pom</packaging>
+
+    <properties>
+        <docs.main>spring-cloud-alibaba</docs.main>
+        <main.basedir>${basedir}/..</main.basedir>
+    </properties>
+
+    <profiles>
+        <profile>
+            <id>docs</id>
+            <build>
+                <plugins>
+                    <plugin>
+                        <groupId>org.apache.maven.plugins</groupId>
+                        <artifactId>maven-dependency-plugin</artifactId>
+                    </plugin>
+                    <plugin>
+                        <groupId>org.asciidoctor</groupId>
+                        <artifactId>asciidoctor-maven-plugin</artifactId>
+                        <inherited>false</inherited>
+                        <configuration>
+                            <sourceDirectory>${basedir}/src/main/asciidoc-zh</sourceDirectory>
+                        </configuration>
+                    </plugin>
+                    <plugin>
+                        <groupId>com.agilejava.docbkx</groupId>
+                        <artifactId>docbkx-maven-plugin</artifactId>
+                    </plugin>
+                    <plugin>
+                        <groupId>org.codehaus.mojo</groupId>
+                        <artifactId>build-helper-maven-plugin</artifactId>
+                        <inherited>false</inherited>
+                    </plugin>
+                </plugins>
+            </build>
+        </profile>
+    </profiles>
+
+</project>
+
--- a/spring-cloud-alibaba-docs/src/main/asciidoc-zh/acm.adoc
+++ b/spring-cloud-alibaba-docs/src/main/asciidoc-zh/acm.adoc
@ -0,0 +1 @@
+== Spring Cloud AliCloud ACM
--- a/spring-cloud-alibaba-docs/src/main/asciidoc-zh/ans.adoc
+++ b/spring-cloud-alibaba-docs/src/main/asciidoc-zh/ans.adoc
@ -0,0 +1 @@
+== Spring Cloud AliCloud ANS
--- a/spring-cloud-alibaba-docs/src/main/asciidoc-zh/dependency-management.adoc
+++ b/spring-cloud-alibaba-docs/src/main/asciidoc-zh/dependency-management.adoc
@ -0,0 +1,4 @@
+== 依赖管理
+
+Spring Cloud Alibaba BOM 包含了它所使用的所有依赖的版本。
+
--- a/spring-cloud-alibaba-docs/src/main/asciidoc-zh/nacos-config.adoc
+++ b/spring-cloud-alibaba-docs/src/main/asciidoc-zh/nacos-config.adoc
@ -0,0 +1 @@
+== Spring Cloud Alibaba Nacos Config
--- a/spring-cloud-alibaba-docs/src/main/asciidoc-zh/nacos-discovery.adoc
+++ b/spring-cloud-alibaba-docs/src/main/asciidoc-zh/nacos-discovery.adoc
@ -0,0 +1 @@
+== Spring Cloud Alibaba Nacos Discovery
--- a/spring-cloud-alibaba-docs/src/main/asciidoc-zh/oss.adoc
+++ b/spring-cloud-alibaba-docs/src/main/asciidoc-zh/oss.adoc
@ -0,0 +1 @@
+== Spring Cloud AliCloud OSS
--- a/spring-cloud-alibaba-docs/src/main/asciidoc-zh/rocketmq.adoc
+++ b/spring-cloud-alibaba-docs/src/main/asciidoc-zh/rocketmq.adoc
@ -0,0 +1 @@
+== Spring Cloud Alibaba Rocket Binder
--- a/spring-cloud-alibaba-docs/src/main/asciidoc-zh/sentinel.adoc
+++ b/spring-cloud-alibaba-docs/src/main/asciidoc-zh/sentinel.adoc
@ -0,0 +1 @@
+== Spring Cloud Alibaba Sentinel
--- a/spring-cloud-alibaba-docs/src/main/asciidoc-zh/spring-cloud-alibaba.adoc
+++ b/spring-cloud-alibaba-docs/src/main/asciidoc-zh/spring-cloud-alibaba.adoc
@ -0,0 +1,31 @@
+[[spring-cloud-alibaba-reference]]
+= Spring Cloud Alibaba 参考文档
+xiaojing; xiaolongzuo; jim fang; bingting peng
+:doctype: book
+:toc:
+:toclevels: 4
+:source-highlighter: prettify
+:numbered:
+
+== 介绍
+
+Spring Cloud Alibaba 致力于提供分布式应用服务开发的一站式解决方案。此项目包含开发分布式应用服务的必需组件，方便开发者通过 Spring Cloud 编程模型轻松使用这些组件来开发分布式应用服务。
+
+依托 Spring Cloud Alibaba，您只需要添加一些注解和少量配置，就可以将 Spring Cloud 应用接入阿里分布式应用解决方案，通过阿里中间件来迅速搭建分布式应用系统。
+
+include::dependency-management.adoc[]
+
+include::nacos-discovery.adoc[]
+
+include::nacos-config.adoc[]
+
+include::sentinel.adoc[]
+
+include::rocketmq.adoc[]
+
+include::ans.adoc[]
+
+include::acm.adoc[]
+
+include::oss.adoc[]
+
--- a/spring-cloud-alibaba-docs/src/main/asciidoc/acm.adoc
+++ b/spring-cloud-alibaba-docs/src/main/asciidoc/acm.adoc
@ -0,0 +1 @@
+== Spring Cloud AliCloud ACM
--- a/spring-cloud-alibaba-docs/src/main/asciidoc/ans.adoc
+++ b/spring-cloud-alibaba-docs/src/main/asciidoc/ans.adoc
@ -0,0 +1 @@
+== Spring Cloud AliCloud ANS
--- a/spring-cloud-alibaba-docs/src/main/asciidoc/dependency-management.adoc
+++ b/spring-cloud-alibaba-docs/src/main/asciidoc/dependency-management.adoc
@ -0,0 +1,4 @@
+== Dependency Management
+
+The Spring Cloud Alibaba Bill of Materials (BOM) contains the versions of all the dependencies it uses.
+
--- a/spring-cloud-alibaba-docs/src/main/asciidoc/nacos-config.adoc
+++ b/spring-cloud-alibaba-docs/src/main/asciidoc/nacos-config.adoc
@ -0,0 +1 @@
+== Spring Cloud Alibaba Nacos Config
--- a/spring-cloud-alibaba-docs/src/main/asciidoc/nacos-discovery.adoc
+++ b/spring-cloud-alibaba-docs/src/main/asciidoc/nacos-discovery.adoc
@ -0,0 +1 @@
+== Spring Cloud Alibaba Nacos Discovery
--- a/spring-cloud-alibaba-docs/src/main/asciidoc/oss.adoc
+++ b/spring-cloud-alibaba-docs/src/main/asciidoc/oss.adoc
@ -0,0 +1 @@
+== Spring Cloud AliCloud OSS
--- a/spring-cloud-alibaba-docs/src/main/asciidoc/rocketmq.adoc
+++ b/spring-cloud-alibaba-docs/src/main/asciidoc/rocketmq.adoc
@ -0,0 +1 @@
+== Spring Cloud Alibaba Rocket Binder
--- a/spring-cloud-alibaba-docs/src/main/asciidoc/sentinel.adoc
+++ b/spring-cloud-alibaba-docs/src/main/asciidoc/sentinel.adoc
@ -0,0 +1 @@
+== Spring Cloud Alibaba Sentinel
--- a/spring-cloud-alibaba-docs/src/main/asciidoc/spring-cloud-alibaba.adoc
+++ b/spring-cloud-alibaba-docs/src/main/asciidoc/spring-cloud-alibaba.adoc
@ -0,0 +1,31 @@
+[[spring-cloud-alibaba-reference]]
+= Spring Cloud Alibaba Reference Documentation
+xiaojing; xiaolongzuo; jim fang; bingting peng
+:doctype: book
+:toc:
+:toclevels: 4
+:source-highlighter: prettify
+:numbered:
+
+== Introduction
+
+Spring Cloud Alibaba provides a one-stop solution for distributed application development. It contains all the components required to develop distributed applications, making it easy for you to develop your applications using Spring Cloud.
+
+With Spring Cloud Alibaba, you only need to add some annotations and a small amount of configurations to connect Spring Cloud applications to the distributed solutions of Alibaba, and build a distributed application system with Alibaba middleware.
+
+include::dependency-management.adoc[]
+
+include::nacos-discovery.adoc[]
+
+include::nacos-config.adoc[]
+
+include::sentinel.adoc[]
+
+include::rocketmq.adoc[]
+
+include::ans.adoc[]
+
+include::acm.adoc[]
+
+include::oss.adoc[]
+