Skip to content

Commit

Permalink
docs: Polish README.md and README.zh-Hans.md
Browse files Browse the repository at this point in the history
Signed-off-by: Eric Zhao <sczyh16@gmail.com>
  • Loading branch information
sczyh30 committed Nov 15, 2022
1 parent 9d57e04 commit 22f0350
Show file tree
Hide file tree
Showing 4 changed files with 41 additions and 23 deletions.
20 changes: 13 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

[![License: Apache-2.0](https://img.shields.io/badge/license-Apache%202.0-blue.svg)](https://www.apache.org/licenses/LICENSE-2.0.txt)

[中文](./README.zh-Hans.md)
[中文说明](./README.zh-Hans.md)

## Overview

Expand All @@ -16,11 +16,11 @@ In the scenario of heterogeneous microservices system, enterprises can manage se
## Projects

* [opensergo-specification](https://github.com/opensergo/opensergo-specification): defines the OpenSergo specification
* [opensergo-proto](https://github.com/opensergo/opensergo-proto): the OpenSergo protocol that defines the conmunication between the client and control plane
* [opensergo-dashboard](https://github.com/opensergo/opensergo-dashboard): the unified dashboard to managing the heterogeneous microservices.
* [opensergo-control-plane](https://github.com/opensergo/opensergo-control-plane): responsible for carrying configuration conversion and distribution.
* [opensergo-control-plane](https://github.com/opensergo/opensergo-control-plane): OpenSergo control plane enables unified management for microservice governance rules with OpenSergo CRD.
* [opensergo-proto](https://github.com/opensergo/opensergo-proto): the OpenSergo Universal Transport Service protocol that defines the conmunication between the client and control plane.
* [opensergo-java-sdk](https://github.com/opensergo/opensergo-java-sdk): the Java SDK that implements the OpenSergo specification
* [opensergo-go-sdk](https://github.com/opensergo/opensergo-go-sdk): the Go SDK that implements the OpenSergo specification
* [opensergo-dashboard](https://github.com/opensergo/opensergo-dashboard): the unified dashboard to managing the heterogeneous microservices.

## Community

Expand All @@ -34,8 +34,14 @@ In the scenario of heterogeneous microservices system, enterprises can manage se

* [DingTalk Group](https://page.dingtalk.com/wow/dingtalk/act/en-home): `34826335`

<img src="image/dingtalk-group.jpg" width="300" />
<img src="image/dingtalk-group.jpg" width="300" />

* WeChat Group

OpenSergo official WeChat account (微信公众号): OpenSergo

<img src="image/qrcode_opensergo-wechat-oac.jpg" width="300" />

* WeChat Group (Broker wechat account to add you into the user group):
Broker wechat account to add you into the user group:

<img src="image/wechat-group.jpg" width="300" />
<img src="image/wechat-group.jpg" width="300" />
44 changes: 28 additions & 16 deletions README.zh-Hans.md
Original file line number Diff line number Diff line change
@@ -1,40 +1,52 @@
<img src="/image/opensergo-logo.svg" alt="OpenSergo Logo" width="50%">
<img src="./image/opensergo-logo.svg" alt="OpenSergo Logo" width="50%">

# [OpenSergo 标准规范](./specification/zh-Hans/README.md)
# [OpenSergo 微服务治理标准](./specification/zh-Hans/README.md)

[![License: Apache-2.0](https://img.shields.io/badge/license-Apache%202.0-blue.svg)](https://www.apache.org/licenses/LICENSE-2.0.txt)

[English](./README.md)

## 概述

OpenSergo 是一套开放通用的、面向云原生服务、覆盖微服务及上下游关联组件的微服务治理标准,并根据标准提供一系列的 API 与 SDK 实现。OpenSergo 项目由阿里巴巴、bilibili、CloudWeGo 等企业与社区联合发起,社区主导共建与演进
OpenSergo 是开放通用的,覆盖微服务及上下游关联组件的微服务治理项目。OpenSergo 从微服务的角度出发,涵盖**流量治理、服务容错、服务元信息治理、安全治理**等关键治理领域,提供一系列的治理能力与标准、生态适配与最佳实践,支持 Java, Go, Rust 等多语言生态。OpenSergo 项目由阿里巴巴、bilibili、中国移动、SphereEx 等企业,以及 Kratos、CloudWeGo、ShardingSphere、Database Mesh、Spring Cloud Alibaba、Apache Dubbo 等社区联合发起,共同主导治理标准建设与能力演进

OpenSergo 的最大特点就是**以统一的一套配置/DSL/协议定义服务治理规则,面向多语言异构化架构,做到全链路生态覆盖**。无论微服务的语言是 Java, Go, Node.js 还是其它语言,无论是标准微服务还是 Mesh 接入,从网关到微服务,从数据库到缓存,从服务注册发现到配置,开发者都可以通过同一套 OpenSergo CRD 标准配置针对每一层进行统一的治理管控,而无需关注各框架、语言的差异点,降低异构化、全链路服务治理管控的复杂度。

![landscape](./specification/zh-Hans/images/opensergo-landscape-cn.jpg)
![landscape](./specification/zh-Hans/images/opensergo-spec-areas-cn.png)

## 项目

* [opensergo-specification](https://github.com/opensergo/opensergo-specification): 定义了 OpenSergo 规范。
* [opensergo-proto](https://github.com/opensergo/opensergo-proto): 定义客户端和控制平面之间通信的 OpenSergo 协议。
* [opensergo-dashboard](https://github.com/opensergo/opensergo-dashboard): 管理异构微服务的统一仪表板。
* [opensergo-control-plane](https://github.com/opensergo/opensergo-control-plane): 负责进行配置转换和分发。
* [opensergo-java-sdk](https://github.com/opensergo/opensergo-java-sdk): 实现 OpenSergo 规范的 Java SDK。
* [opensergo-go-sdk](https://github.com/opensergo/opensergo-go-sdk): 实现 OpenSergo 规范的 Go SDK。
* [opensergo-specification](https://github.com/opensergo/opensergo-specification): Spec 以统一的一套配置/DSL 定义微服务治理规则与配置,确保开发者可以用同一套标准对不同框架、不同协议、不同语言的微服务架构进行统一治理管控。
* [opensergo-control-plane](https://github.com/opensergo/opensergo-control-plane): OpenSergo 提供 Control Plane(控制平面)作为 OpenSergo CRD 的统一管控组件,承载配置转换与下发的职责。
* OpenSergo SDK: OpenSergo 多语言 SDK 提供统一的 OpenSergo 适配层,供各个开源框架/组件接入到 OpenSergo 生态中。目前社区已提供 Java SDK 和 Go SDK。
* [opensergo-java-sdk](https://github.com/opensergo/opensergo-java-sdk)
* [opensergo-go-sdk](https://github.com/opensergo/opensergo-go-sdk)
* [opensergo-proto](https://github.com/opensergo/opensergo-proto): 定义客户端和控制平面之间的通信协议定义。
* [opensergo-dashboard](https://github.com/opensergo/opensergo-dashboard): OpenSergo 控制台。

## 社区
### 社区双会议

### 双周会
* 亚太区友好的社区会议:亚太区双周会 (开始于 2022 年 4月 27 日), 周三 19:30-20:30(东八区时间)
* 会议时间:[OpenSergo 双周会](https://github.com/opensergo/opensergo-specification/issues/7)
* 会议记录:OpenSergo 哔哩哔哩频道
OpenSergo 社区会议每两周开展一次(一般是在周三晚,GMT+8),时间为1小时左右,议程如下:

### 联系
[钉钉群](https://www.dingtalk.com/)`34826335`
* 同步上一周期的进展,包括 spec 建设、Control Plane/SDK 建设、框架生态接入等进展,回顾下社区的 Issue/PR 等
* 同步下一周期的规划和方向
* 社区分享

社区会议最新安排可参考[此处](https://github.com/opensergo/opensergo-specification/issues/7)。社区会议记录可见 [GitHub Discussions](https://github.com/opensergo/opensergo-specification/discussions)

### 社区交流方式

- [OpenSergo 钉钉交流群](https://www.dingtalk.com/):34826335

<img src="image/dingtalk-group.jpg" width="300" />

- 微信公众号与微信群

OpenSergo 官方微信公众号:OpenSergo

<img src="image/qrcode_opensergo-wechat-oac.jpg" width="300" />

微信群(添加微信账号并回复 OpenSergo,会你拉进群):

<img src="image/wechat-group.jpg" width="300" />
Binary file added image/qrcode_opensergo-wechat-oac.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 22f0350

Please sign in to comment.