You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@eventmesh.apache.org by mi...@apache.org on 2021/09/07 02:10:18 UTC
[incubator-eventmesh] branch develop updated: Improve the directory
structure of docs (#516)
This is an automated email from the ASF dual-hosted git repository.
mikexue pushed a commit to branch develop
in repository https://gitbox.apache.org/repos/asf/incubator-eventmesh.git
The following commit(s) were added to refs/heads/develop by this push:
new ed57833 Improve the directory structure of docs (#516)
ed57833 is described below
commit ed578334350212b95ef4b9bf86c2f1b4913e85af
Author: Xiaoyang Liu <si...@gmail.com>
AuthorDate: Tue Sep 7 10:10:14 2021 +0800
Improve the directory structure of docs (#516)
* Remove .vuepress
Signed-off-by: Xiaoyang Liu <si...@gmail.com>
* Remove README and theme config in docs
Signed-off-by: Xiaoyang Liu <si...@gmail.com>
* Add _category_.json to help docs sync
Signed-off-by: Xiaoyang Liu <si...@gmail.com>
---
docs/.vuepress/config.js | 93 ---------------------
docs/.vuepress/public/images/bus.png | Bin 105121 -> 0 bytes
docs/.vuepress/public/images/eventmesh-arch.png | Bin 45297 -> 0 bytes
docs/.vuepress/public/images/eventmesh-define.png | Bin 19431 -> 0 bytes
.../public/images/eventmesh-landscape.png | Bin 33151 -> 0 bytes
docs/.vuepress/public/images/eventmesher.png | Bin 91666 -> 0 bytes
.../public/images/features/RR-call-p1.png | Bin 13792 -> 0 bytes
...a-distributing-architecture-in-financial-EN.png | Bin 49874 -> 0 bytes
.../a-distributing-architecture-in-financial.png | Bin 49865 -> 0 bytes
.../images/features/adjust-queue-expand-p1.png | Bin 26604 -> 0 bytes
.../images/features/adjust-queue-shrink-p1.png | Bin 43400 -> 0 bytes
.../public/images/features/architecture-p1.png | Bin 29028 -> 0 bytes
.../.vuepress/public/images/features/broadcast.png | Bin 28016 -> 0 bytes
.../public/images/features/circuit-break-p1.png | Bin 17847 -> 0 bytes
.../public/images/features/dark-launch-p1.png | Bin 30959 -> 0 bytes
.../public/images/features/invoke_nearby-p1.png | Bin 54826 -> 0 bytes
.../.vuepress/public/images/features/multicast.png | Bin 28170 -> 0 bytes
.../public/images/features/subscribe-nearby-p1.png | Bin 24447 -> 0 bytes
.../public/images/features/tongchengduohuo-p1.png | Bin 160110 -> 0 bytes
docs/.vuepress/public/images/features/unicast.png | Bin 18522 -> 0 bytes
docs/.vuepress/public/images/mesh-helper.png | Bin 44009 -> 0 bytes
docs/.vuepress/public/images/qqgroup-crcode.png | Bin 25916 -> 0 bytes
docs/README.md | 90 --------------------
docs/_config.yml | 20 -----
docs/cn/blog/.gitkeep | 0
docs/cn/community/.gitkeep | 0
docs/cn/documentation/.gitkeep | 0
docs/cn/documentation/_category_.json | 4 +
docs/cn/features/_category_.json | 4 +
docs/cn/instructions/_category_.json | 4 +
docs/cn/{README.md => intro.md} | 0
docs/en/blog/.gitkeep | 0
docs/en/community/.gitkeep | 0
docs/en/documentation/.gitkeep | 0
docs/en/documentation/_category_.json | 4 +
docs/en/features/_category_.json | 4 +
docs/en/instructions/_category_.json | 4 +
docs/en/{README.md => intro.md} | 0
docs/eventmesh.md | 37 --------
39 files changed, 24 insertions(+), 240 deletions(-)
diff --git a/docs/.vuepress/config.js b/docs/.vuepress/config.js
deleted file mode 100644
index 870c593..0000000
--- a/docs/.vuepress/config.js
+++ /dev/null
@@ -1,93 +0,0 @@
-/*
- * Licensed to the Apache Software Foundation (ASF) under one
- * or more contributor license agreements. See the NOTICE file
- * distributed with this work for additional information
- * regarding copyright ownership. The ASF licenses this file
- * to you under the Apache License, Version 2.0 (the
- * "License"); you may not use this file except in compliance
- * with the License. You may obtain a copy of the License at
- *
- * http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing,
- * software distributed under the License is distributed on an
- * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
- * KIND, either express or implied. See the License for the
- * specific language governing permissions and limitations
- * under the License.
- */
-
-module.exports = {
- title: 'EventMesh',
- description: 'EventMesh',
- head: [
- ['link', {rel: 'icon', href: '/logo.png'}]
- ],
- locales: {
- '/': {
- lang: 'English',
- title: 'EventMesh',
- description: ''
- },
- '/cn/': {
- lang: '中文',
- title: 'EventMesh',
- description: ''
- },
- },
- themeConfig: {
- locales: {
- '/': {
- selectText: 'Languages',
- label: 'English',
- ariaLabel: 'Languages',
- nav: [
- {text: 'Community', link: '/en/community/'},
- {
- text: 'Blog',
- link: '/en/blog/'
- },
- {
- text: 'Documentation', link: '/en/documentation/'
- },
- {text: 'Github', link: 'https://github.com/WeBankFinTech/EventMesh'},
- ],
- },
- '/en/': {
- selectText: 'Languages',
- label: 'English',
- ariaLabel: 'Languages',
- nav: [
- {text: 'Community', link: '/en/community/'},
- {
- text: 'Blog',
- link: '/en/blog/'
- },
- {
- text: 'Documentation', link: '/en/documentation/'
- },
- {text: 'Github', link: 'https://github.com/WeBankFinTech/EventMesh'},
- ],
- },
- '/cn/': {
- // 多语言下拉菜单的标题
- selectText: '选择语言',
- // 该语言在下拉菜单中的标签
- label: '简体中文',
- nav: [
- {text: '社区', link: '/cn/community/'},
- {
- text: '博客',
- link: '/cn/blog/'
- },
- {
- text: '文档', link: '/en/documentation/'
- },
- {text: 'Github', link: 'https://github.com/WeBankFinTech/EventMesh'},
- ],
- }
- },
-
- sidebar: true
- }
-}
diff --git a/docs/.vuepress/public/images/bus.png b/docs/.vuepress/public/images/bus.png
deleted file mode 100644
index f289f63..0000000
Binary files a/docs/.vuepress/public/images/bus.png and /dev/null differ
diff --git a/docs/.vuepress/public/images/eventmesh-arch.png b/docs/.vuepress/public/images/eventmesh-arch.png
deleted file mode 100644
index fccf225..0000000
Binary files a/docs/.vuepress/public/images/eventmesh-arch.png and /dev/null differ
diff --git a/docs/.vuepress/public/images/eventmesh-define.png b/docs/.vuepress/public/images/eventmesh-define.png
deleted file mode 100644
index 0f28170..0000000
Binary files a/docs/.vuepress/public/images/eventmesh-define.png and /dev/null differ
diff --git a/docs/.vuepress/public/images/eventmesh-landscape.png b/docs/.vuepress/public/images/eventmesh-landscape.png
deleted file mode 100644
index fcce7f2..0000000
Binary files a/docs/.vuepress/public/images/eventmesh-landscape.png and /dev/null differ
diff --git a/docs/.vuepress/public/images/eventmesher.png b/docs/.vuepress/public/images/eventmesher.png
deleted file mode 100644
index c3e6a76..0000000
Binary files a/docs/.vuepress/public/images/eventmesher.png and /dev/null differ
diff --git a/docs/.vuepress/public/images/features/RR-call-p1.png b/docs/.vuepress/public/images/features/RR-call-p1.png
deleted file mode 100644
index 2232df3..0000000
Binary files a/docs/.vuepress/public/images/features/RR-call-p1.png and /dev/null differ
diff --git a/docs/.vuepress/public/images/features/a-distributing-architecture-in-financial-EN.png b/docs/.vuepress/public/images/features/a-distributing-architecture-in-financial-EN.png
deleted file mode 100644
index 7e7b3d7..0000000
Binary files a/docs/.vuepress/public/images/features/a-distributing-architecture-in-financial-EN.png and /dev/null differ
diff --git a/docs/.vuepress/public/images/features/a-distributing-architecture-in-financial.png b/docs/.vuepress/public/images/features/a-distributing-architecture-in-financial.png
deleted file mode 100644
index d7eeb9d..0000000
Binary files a/docs/.vuepress/public/images/features/a-distributing-architecture-in-financial.png and /dev/null differ
diff --git a/docs/.vuepress/public/images/features/adjust-queue-expand-p1.png b/docs/.vuepress/public/images/features/adjust-queue-expand-p1.png
deleted file mode 100644
index 2660f31..0000000
Binary files a/docs/.vuepress/public/images/features/adjust-queue-expand-p1.png and /dev/null differ
diff --git a/docs/.vuepress/public/images/features/adjust-queue-shrink-p1.png b/docs/.vuepress/public/images/features/adjust-queue-shrink-p1.png
deleted file mode 100644
index e4dc500..0000000
Binary files a/docs/.vuepress/public/images/features/adjust-queue-shrink-p1.png and /dev/null differ
diff --git a/docs/.vuepress/public/images/features/architecture-p1.png b/docs/.vuepress/public/images/features/architecture-p1.png
deleted file mode 100644
index cda0b04..0000000
Binary files a/docs/.vuepress/public/images/features/architecture-p1.png and /dev/null differ
diff --git a/docs/.vuepress/public/images/features/broadcast.png b/docs/.vuepress/public/images/features/broadcast.png
deleted file mode 100644
index 2cf528d..0000000
Binary files a/docs/.vuepress/public/images/features/broadcast.png and /dev/null differ
diff --git a/docs/.vuepress/public/images/features/circuit-break-p1.png b/docs/.vuepress/public/images/features/circuit-break-p1.png
deleted file mode 100644
index b3f55f7..0000000
Binary files a/docs/.vuepress/public/images/features/circuit-break-p1.png and /dev/null differ
diff --git a/docs/.vuepress/public/images/features/dark-launch-p1.png b/docs/.vuepress/public/images/features/dark-launch-p1.png
deleted file mode 100644
index 08c0443..0000000
Binary files a/docs/.vuepress/public/images/features/dark-launch-p1.png and /dev/null differ
diff --git a/docs/.vuepress/public/images/features/invoke_nearby-p1.png b/docs/.vuepress/public/images/features/invoke_nearby-p1.png
deleted file mode 100644
index 2aa0afe..0000000
Binary files a/docs/.vuepress/public/images/features/invoke_nearby-p1.png and /dev/null differ
diff --git a/docs/.vuepress/public/images/features/multicast.png b/docs/.vuepress/public/images/features/multicast.png
deleted file mode 100644
index 9643044..0000000
Binary files a/docs/.vuepress/public/images/features/multicast.png and /dev/null differ
diff --git a/docs/.vuepress/public/images/features/subscribe-nearby-p1.png b/docs/.vuepress/public/images/features/subscribe-nearby-p1.png
deleted file mode 100644
index d3a1419..0000000
Binary files a/docs/.vuepress/public/images/features/subscribe-nearby-p1.png and /dev/null differ
diff --git a/docs/.vuepress/public/images/features/tongchengduohuo-p1.png b/docs/.vuepress/public/images/features/tongchengduohuo-p1.png
deleted file mode 100644
index 663186a..0000000
Binary files a/docs/.vuepress/public/images/features/tongchengduohuo-p1.png and /dev/null differ
diff --git a/docs/.vuepress/public/images/features/unicast.png b/docs/.vuepress/public/images/features/unicast.png
deleted file mode 100644
index 1be6269..0000000
Binary files a/docs/.vuepress/public/images/features/unicast.png and /dev/null differ
diff --git a/docs/.vuepress/public/images/mesh-helper.png b/docs/.vuepress/public/images/mesh-helper.png
deleted file mode 100644
index 05e0c29..0000000
Binary files a/docs/.vuepress/public/images/mesh-helper.png and /dev/null differ
diff --git a/docs/.vuepress/public/images/qqgroup-crcode.png b/docs/.vuepress/public/images/qqgroup-crcode.png
deleted file mode 100644
index 10ca3c2..0000000
Binary files a/docs/.vuepress/public/images/qqgroup-crcode.png and /dev/null differ
diff --git a/docs/README.md b/docs/README.md
deleted file mode 100644
index 5909122..0000000
--- a/docs/README.md
+++ /dev/null
@@ -1,90 +0,0 @@
-# Apache EventMesh (Incubating)
-[](https://github.com/apache/incubator-eventmesh/actions/workflows/ci.yml)
-[](https://codecov.io/gh/apache/incubator-eventmesh)
-[](https://lgtm.com/projects/g/apache/incubator-eventmesh/context:java)
-[](https://lgtm.com/projects/g/apache/incubator-eventmesh/alerts/)
-[](https://github.com/apache/incubator-eventmesh/releases)
-[](https://www.apache.org/licenses/LICENSE-2.0.html)
-
-[点我查看中文版](cn/README.md)
-
-## What is Event Mesh?
-
-EventMesh is a dynamic cloud-native eventing infrastruture used to decouple the application and backend middleware
-layer, which supports a wide range of use cases that encompass complex multi-cloud, widely distributed topologies using
-diverse technology stacks.
-
-
-**EventMesh Architecture:**
-
-
-
-**EventMesh Cloud Native Structure:**
-
-
-
-The event mesh allows events from one application to be dynamically routed to any other application. General functions
-of the event mesh:
-
-* Event driven;
-* Event governance;
-* Dynamic routing;
-* Cloud native
-
-Dependent components:
-
-* [RocketMQ](https://github.com/apache/rocketmq):RocketMQ is a distributed messaging and streaming platform with low
- latency, high performance and reliability, trillion-level capacity and flexible scalability.
-
-Key components:
-
-* eventmesh-runtime : an middleware to transmit events between event producers and consumers, support cloud native apps
- and microservices
-* eventmesh-sdk-java : currently supports HTTP and TCP protocols, and will support gRPC in the future
-
-## RoadMap
-
-| version | feature |
-| ---- | ---- |
-| v1.0.0 |Support pub/sub, http api, java-sdk|
-| v1.1.0 |Support rocketmq as eventstore|
-| v1.2.0 |Support Plug-in architecture, support http sub，support cloud native deploy|
-| V1.3.0 |Support CloudEvents protocol|
-| |Support transaction event|
-| |Support Event Sourcing|
-| |Support Event orchestration|
-| |Support Dashboard|
-| |Support Event governance|
-| |Support Nacos as an event router|
-| |Support Promethus|
-| |Support Skywalking|
-| |Support Spiffe|
-| |Support gRPC|
-| |Support c/go/python/NodeJs/wasm SDK|
-
-## Quick Start
-
-1. Build and deploy event-store(RocketMQ), see [instruction](https://rocketmq.apache.org/docs/quick-start/).
-2. Build and deploy eventmesh-runtime, see
- instruction ['eventmesh-runtime quickstart'](en/instructions/eventmesh-runtime-quickstart.md).
-3. Run eventmesh-sdk-java demo, see
- instruction ['eventmesh-sdk-java quickstart'](en/instructions/eventmesh-sdk-java-quickstart.md).
-
-## Contributing
-
-Contributions are always welcomed! Please see [CONTRIBUTING](../CONTRIBUTING.md) for detailed guidelines
-
-You can start with the issues labeled with good first issue.
-[GitHub Issues](https://github.com/WeBankFinTech/EventMesh/issues)
-
-## License
-
-[Apache License, Version 2.0](http://www.apache.org/licenses/LICENSE-2.0.html) Copyright (C) Apache Software Foundation
-
-## Contacts
-
-WeChat group：
-
-
-
-
diff --git a/docs/_config.yml b/docs/_config.yml
deleted file mode 100644
index 3ef20c1..0000000
--- a/docs/_config.yml
+++ /dev/null
@@ -1,20 +0,0 @@
-#
-# Licensed to the Apache Software Foundation (ASF) under one
-# or more contributor license agreements. See the NOTICE file
-# distributed with this work for additional information
-# regarding copyright ownership. The ASF licenses this file
-# to you under the Apache License, Version 2.0 (the
-# "License"); you may not use this file except in compliance
-# with the License. You may obtain a copy of the License at
-#
-# http://www.apache.org/licenses/LICENSE-2.0
-#
-# Unless required by applicable law or agreed to in writing,
-# software distributed under the License is distributed on an
-# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
-# KIND, either express or implied. See the License for the
-# specific language governing permissions and limitations
-# under the License.
-#
-
-theme: jekyll-theme-cayman
diff --git a/docs/cn/blog/.gitkeep b/docs/cn/blog/.gitkeep
deleted file mode 100644
index e69de29..0000000
diff --git a/docs/cn/community/.gitkeep b/docs/cn/community/.gitkeep
deleted file mode 100644
index e69de29..0000000
diff --git a/docs/cn/documentation/.gitkeep b/docs/cn/documentation/.gitkeep
deleted file mode 100644
index e69de29..0000000
diff --git a/docs/cn/documentation/_category_.json b/docs/cn/documentation/_category_.json
new file mode 100644
index 0000000..95b7eed
--- /dev/null
+++ b/docs/cn/documentation/_category_.json
@@ -0,0 +1,4 @@
+{
+ "label": "Documentation",
+ "collapsed": false
+}
diff --git a/docs/cn/features/_category_.json b/docs/cn/features/_category_.json
new file mode 100644
index 0000000..3b60a9e
--- /dev/null
+++ b/docs/cn/features/_category_.json
@@ -0,0 +1,4 @@
+{
+ "label": "Features",
+ "collapsed": false
+}
diff --git a/docs/cn/instructions/_category_.json b/docs/cn/instructions/_category_.json
new file mode 100644
index 0000000..06fd721
--- /dev/null
+++ b/docs/cn/instructions/_category_.json
@@ -0,0 +1,4 @@
+{
+ "label": "Instructions",
+ "collapsed": false
+}
diff --git a/docs/cn/README.md b/docs/cn/intro.md
similarity index 100%
rename from docs/cn/README.md
rename to docs/cn/intro.md
diff --git a/docs/en/blog/.gitkeep b/docs/en/blog/.gitkeep
deleted file mode 100644
index e69de29..0000000
diff --git a/docs/en/community/.gitkeep b/docs/en/community/.gitkeep
deleted file mode 100644
index e69de29..0000000
diff --git a/docs/en/documentation/.gitkeep b/docs/en/documentation/.gitkeep
deleted file mode 100644
index e69de29..0000000
diff --git a/docs/en/documentation/_category_.json b/docs/en/documentation/_category_.json
new file mode 100644
index 0000000..95b7eed
--- /dev/null
+++ b/docs/en/documentation/_category_.json
@@ -0,0 +1,4 @@
+{
+ "label": "Documentation",
+ "collapsed": false
+}
diff --git a/docs/en/features/_category_.json b/docs/en/features/_category_.json
new file mode 100644
index 0000000..3b60a9e
--- /dev/null
+++ b/docs/en/features/_category_.json
@@ -0,0 +1,4 @@
+{
+ "label": "Features",
+ "collapsed": false
+}
diff --git a/docs/en/instructions/_category_.json b/docs/en/instructions/_category_.json
new file mode 100644
index 0000000..06fd721
--- /dev/null
+++ b/docs/en/instructions/_category_.json
@@ -0,0 +1,4 @@
+{
+ "label": "Instructions",
+ "collapsed": false
+}
diff --git a/docs/en/README.md b/docs/en/intro.md
similarity index 100%
rename from docs/en/README.md
rename to docs/en/intro.md
diff --git a/docs/eventmesh.md b/docs/eventmesh.md
deleted file mode 100644
index 432c093..0000000
--- a/docs/eventmesh.md
+++ /dev/null
@@ -1,37 +0,0 @@
-## 什么是Event Mesh？
-
-EventMesh是一个动态的云原生事件驱动架构基础设施，用于分离应用程序和后端中间件层，它支持广泛的用例，包括复杂的混合云、使用了不同技术栈的分布式架构。
-
-
-**EventMesh架构：**
-
-
-
-**EventMesh云原生结构：**
-
-
-
-EventMesh允许将来自一个应用程序的事件动态路由到任何其他应用程序. EventMesh的一般功能:
-
-* 事件驱动;
-* 事件治理;
-* 动态路由;
-* 云原生;
-
-依赖部件：
-
-* [RocketMQ](https://github.com/apache/rocketmq)：RocketMQ是一个分布式消息流平台，具有低延迟、高性能和可靠性、万亿级容量和灵活的可伸缩性。
-
-关键部件：
-
-* eventmesh-runtime：一种中间件，用于在事件产生者和使用者之间传输事件，支持云原生应用程序和微服务
-* eventmesh-sdk-java：当前支持HTTP和TCP协议，未来会支持gRPC等
-
-## 开源地址
-
-* https://github.com/WeBankFinTech/DeFiBus
-* https://github.com/apache/incubator-eventmesh
-* https://gitee.com/WeBank/DeFiBus
-* https://gitee.com/WeBank/EventMesh
-
-欢迎加入社区进行交流
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@eventmesh.apache.org
For additional commands, e-mail: commits-help@eventmesh.apache.org