Skip to content

Commit

Permalink
docs: rename readme to .zh_CN.md (trpc-group#66)
Browse files Browse the repository at this point in the history
Reference: trpc-group#60
  • Loading branch information
WineChord authored Oct 9, 2023
1 parent 27a655b commit 977210a
Show file tree
Hide file tree
Showing 80 changed files with 108 additions and 108 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
[![Tests](https://github.com/trpc.group/trpc-go/actions/workflows/prc.yaml/badge.svg)](https://github.com/trpc.group/trpc-go/actions/workflows/prc.yaml)
[![Coverage](https://codecov.io/gh/trpc.group/trpc-go/branch/main/graph/badge.svg)](https://app.codecov.io/gh/trpc.group/trpc-go/tree/main)

English | [中文](README_CN.md)
English | [中文](README.zh_CN.md)

tRPC-Go, as the [Go][] language implementation of [tRPC][], is a battle-tested microservices framework that has been extensively validated in production environments. It not only delivers high performance but also offers ease of use and testability.

Expand Down
File renamed without changes.
2 changes: 1 addition & 1 deletion admin/README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
English | [中文](./README_CN.md)
English | [中文](./README.zh_CN.md)

# Introduction

Expand Down
File renamed without changes.
2 changes: 1 addition & 1 deletion client/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# tRPC-Go Client Package

English | [中文](README_CN.md)
English | [中文](README.zh_CN.md)

## Background

Expand Down
File renamed without changes.
2 changes: 1 addition & 1 deletion codec/README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
English | [中文](README_zh_CN.md)
English | [中文](README.zh_CN.md)
The `codec` package can support any third-party business communication protocol by simply implementing the relevant interfaces.
The following introduces the related interfaces of the `codec` package with the server-side protocol processing flow as an example.
The client-side protocol processing flow is the reverse of the server-side protocol processing flow, and is not described here.
Expand Down
2 changes: 1 addition & 1 deletion codec/README_zh_CN.md → codec/README.zh_CN.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@

`codec` 包可以支持任意的第三方业务通信协议,只需要实现相关接口即可。
下面以服务端的协议处理流程为例介绍 `codec` 的相关接口, 客户端的协议处理流程与服务端的协议处理流程相反,这里不再赘述。
关于怎么开发第三方业务通信协议的插件, 可参考[这里](/docs/developer_guide/develop_plugins/protocol_zh_CN.md)
关于怎么开发第三方业务通信协议的插件, 可参考[这里](/docs/developer_guide/develop_plugins/protocol.zh_CN.md)

## 相关接口

Expand Down
2 changes: 1 addition & 1 deletion config/README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
English | [中文](./README_zh_CN.md)
English | [中文](./README.zh_CN.md)

# Introduction

Expand Down
2 changes: 1 addition & 1 deletion config/README_zh_CN.md → config/README.zh_CN.md
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@ c.GetString("auth.user", "admin")
在这个示例中,数据源为 etcd 配置中心,数据源中的业务配置文件为“test.yaml”。当 ConfigLoader 获取到"test.yaml"业务配置时,指定使用 yaml 格式对数据内容进行解码。最后通过`c.GetString("server.app", "default")`函数来获取 test.yaml 文件中`auth.user`这个配置型的值。

# 接口使用
本文仅从使用业务配置的角度来介绍相应的接口,如何用户需要开发数据源插件或者 Codec 插件,请参考 [tRPC-Go 开发配置插件](/docs/developer_guide/develop_plugins/config_zh_CN.md)
本文仅从使用业务配置的角度来介绍相应的接口,如何用户需要开发数据源插件或者 Codec 插件,请参考 [tRPC-Go 开发配置插件](/docs/developer_guide/develop_plugins/config.zh_CN.md)

tRPC-Go 框架提供了两套接口分别用于 “读取配置项” 和 “监听配置项”
## 获取配置项
Expand Down
2 changes: 1 addition & 1 deletion docs/README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
English | [中文](README_zh_CN.md)
English | [中文](README.zh_CN.md)

- [tRPC-Go Overview](/README.md)
- [Quick Start](/examples/helloworld/README.md)
Expand Down
47 changes: 47 additions & 0 deletions docs/README.zh_CN.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
[English](README.md) | 中文

- [框架概述](/README.zh_CN.md)
- [快速上手](/examples/helloworld/README.md)
- 用户指南
- [框架配置](/docs/user_guide/framework_conf.zh_CN.md)
- [业务配置](/config/README.zh_CN.md)
- 服务端开发
- [服务端开发向导](/docs/user_guide/server/overview.zh_CN.md)
- [HTTP RESTful 服务](/restful/README.zh_CN.md)
- [流式服务](/stream/README.zh_CN.md)
- [FlatBuffers 服务](/docs/user_guide/server/flatbuffers.zh_CN.md)
- 客户端开发
- [客户端开发向导](/docs/user_guide/client/overview.zh_CN.md)
- [调用 FlatBuffers 服务](/docs/user_guide/client/flatbuffers.zh_CN.md)
- [错误码](/errs/README.zh_CN.md)
- [超时控制](/docs/user_guide/timeout_control.zh_CN.md)
- [指标监控](/metrics/README.zh_CN.md)
- [重试对冲](https://github.com/trpc-ecosystem/go-filter/blob/main/slime/README.zh_CN.md)
- [日志管理](/log/README.zh_CN.md)
- [管理命令](/admin/README.zh_CN.md)
- [链路透传](/docs/user_guide/metadata_transmission.zh_CN.md)
- [反向代理](/docs/user_guide/reverse_proxy.zh_CN.md)
- [优雅重启](/docs/user_guide/graceful_restart.zh_CN.md)
- [健康检查](/healthcheck/README.zh_CN.md)
- [命令行工具](https://github.com/trpc-group/trpc-go-cmdline)
- [高性能网络库 tnet](/docs/user_guide/tnet.zh_CN.md)
- [运行状态追踪](/rpcz/README.zh_CN.md)
- [附件(大二进制数据)传输](/docs/user_guide/attachment.zh_CN.md)
- 开发指南
- 插件开发
- [插件向导](/plugin/README.zh_CN.md)
- [拦截器插件](/filter/README.zh_CN.md)
- [配置插件](/docs/developer_guide/develop_plugins/config.zh_CN.md)
- [协议插件](/docs/developer_guide/develop_plugins/protocol.zh_CN.md)
- [日志插件](/docs/developer_guide/develop_plugins/log.zh_CN.md)
- [监控插件](/docs/developer_guide/develop_plugins/metrics.zh_CN.md)
- [名字服务插件](/docs/developer_guide/develop_plugins/naming.zh_CN.md)
- 模块设计
- [server](/server/README.zh_CN.md)
- [client](/client/README.zh_CN.md)
- [log](/log/README.zh_CN.md)
- [conn pool](/pool/connpool/README.zh_CN.md)
- [naming](/naming/README.zh_CN.md)
- [transport](/transport/README.zh_CN.md)
- [metrics](/metrics/README.zh_CN.md)
- [codec](/codec/README.zh_CN.md)
47 changes: 0 additions & 47 deletions docs/README_zh_CN.md

This file was deleted.

2 changes: 1 addition & 1 deletion docs/developer_guide/develop_plugins/config.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
English | [中文](config_zh_CN.md)
English | [中文](config.zh_CN.md)

# How to develop a config type plugin

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@

开发该插件需要实现以下两个子功能:

- 实现插件依赖配置进行加载,详细说明请参考 [plugin](/plugin/README_zh_CN.md)
- 实现插件依赖配置进行加载,详细说明请参考 [plugin](/plugin/README.zh_CN.md)
- 实现 `config.KVConfig` 接口,并将实现注册到 `config`

下面以 [trpc-config-etcd](https://github.com/trpc-ecosystem/go-config-etcd) 为例,来介绍相关开发步骤。
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,9 @@
该插件将上报发起 RPC 时,client 端发送请求到 server 端收到回复的耗时, 以及 server 端收到请求到回复 client 的耗时。
开发该插件需要实现以下三个子功能:

- 实现插件依赖配置进行加载,详细说明请参考 [plugin](/plugin/README_CN.md)
- 实现让监控指标上报到外部平台,详细说明请参考 [metrics](/metrics/README_CN.md)
- 实现在拦截器中上报监控指标,详细说明请参考 [filter](/filter/README_CN.md)
- 实现插件依赖配置进行加载,详细说明请参考 [plugin](/plugin/README.zh_CN.md)
- 实现让监控指标上报到外部平台,详细说明请参考 [metrics](/metrics/README.zh_CN.md)
- 实现在拦截器中上报监控指标,详细说明请参考 [filter](/filter/README.zh_CN.md)

下面以 [trpc-metrics-prometheus](https://github.com/trpc-ecosystem/go-metrics-prometheus) 为例,来介绍相关开发步骤。

Expand Down
4 changes: 2 additions & 2 deletions docs/developer_guide/develop_plugins/naming.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
English | [中文](naming_zh_CN.md)
English | [中文](naming.zh_CN.md)

## Background

Like most other modules in tRPC-Go, the name service module also supports plugin. This article assumes that you have read the [README](/naming/README_zh_CN.md) of the naming package.
Like most other modules in tRPC-Go, the name service module also supports plugin. This article assumes that you have read the [README](/naming/README.zh_CN.md) of the naming package.

## Pluggable Design

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

## 前言

像 tRPC-Go 大部分其他模块一样,名字服务模块也支持插件化。本文假定你已经阅读了 naming 包的 [README](/naming/README_zh_CN.md)
像 tRPC-Go 大部分其他模块一样,名字服务模块也支持插件化。本文假定你已经阅读了 naming 包的 [README](/naming/README.zh_CN.md)

## 插件化设计

Expand Down
2 changes: 1 addition & 1 deletion docs/developer_guide/develop_plugins/protocol.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
English | [中文](protocol_zh_CN.md)
English | [中文](protocol.zh_CN.md)

# How to develop a protocol type plugin

Expand Down
2 changes: 1 addition & 1 deletion docs/quick_start.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Quick Start

English | [中文](quick_start_zh_CN.md)
English | [中文](quick_start.zh_CN.md)

## Prerequisites

Expand Down
File renamed without changes.
Original file line number Diff line number Diff line change
Expand Up @@ -11,4 +11,4 @@ tRPC 协议支持通过简单 RPC 发送附件。

- 考虑使用 tRPC 流式分割大二进制数据,其中二进制数据被分块并通过多个消息进行流式传输,更多详细信息,可以参考[流式传输数据的例子](../../examples/features/stream)

- 考虑使用其他协议如[流式 http](https://gist.github.com/CMCDragonkai/6bfade6431e9ffb7fe88), 更多使用上的例子,可参考 [客户端服务端收发 HTTP chunked](../../http/README_CN.md#%E5%AE%A2%E6%88%B7%E7%AB%AF%E6%9C%8D%E5%8A%A1%E7%AB%AF%E6%94%B6%E5%8F%91-http-chunked)
- 考虑使用其他协议如[流式 http](https://gist.github.com/CMCDragonkai/6bfade6431e9ffb7fe88), 更多使用上的例子,可参考 [客户端服务端收发 HTTP chunked](../../http/README.zh_CN.md#%E5%AE%A2%E6%88%B7%E7%AB%AF%E6%9C%8D%E5%8A%A1%E7%AB%AF%E6%94%B6%E5%8F%91-http-chunked)
2 changes: 1 addition & 1 deletion docs/user_guide/client/connection_mode.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# tRPC-Go client connection mode

English | [中文](./connection_mode_zh_CN.md)
English | [中文](./connection_mode.zh_CN.md)

## Introduction

Expand Down
6 changes: 3 additions & 3 deletions docs/user_guide/client/flatbuffers.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,16 @@
English | [中文](./flatbuffers_zh_CN.md)
English | [中文](./flatbuffers.zh_CN.md)

# Introduction

This section shows how to call flatbuffers services in tRPC-Go.

# Principles

See [tRPC-Go builds flatbuffers service](/docs/user_guide/server/flatbuffers_zh_CN.md).
See [tRPC-Go builds flatbuffers service](/docs/user_guide/server/flatbuffers.zh_CN.md).

# 示例

In examples from [tRPC-Go builds flatbuffers service](/docs/user_guide/server/flatbuffers_zh_CN.md), we can generate the client. The project structure is as follows:
In examples from [tRPC-Go builds flatbuffers service](/docs/user_guide/server/flatbuffers.zh_CN.md), we can generate the client. The project structure is as follows:

```shell
├── cmd/client/main.go # client
Expand Down
File renamed without changes.
2 changes: 1 addition & 1 deletion docs/user_guide/client/overview.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
tRPC-Go Client Development Guide

English | [中文](overview_zh_CN.md)
English | [中文](overview.zh_CN.md)

# Introduction

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -18,15 +18,15 @@ tRPC-Go 框架提供了多种类型的服务调用,我们把服务调用按协

tRPC-Go 提供了以下内置协议的服务调用:

- [调用 tRPC 服务](/docs/quick_start_zh_CN.md)
- [调用 tRPC 服务](/docs/quick_start.zh_CN.md)

**第三方协议**

tRPC-Go 提供了丰富的协议插件,供客户端实现和第三方协议服务进行对接。同时框架也支持用户自定义协议插件。关于协议插件的开发,请参考 [这里](/docs/developer_guide/develop_plugins/protocol_zh_CN.md),常见的第三方协议可以参考 [trpc-ecosystem/go-codec](https://github.com/trpc-ecosystem/go-codec)
tRPC-Go 提供了丰富的协议插件,供客户端实现和第三方协议服务进行对接。同时框架也支持用户自定义协议插件。关于协议插件的开发,请参考 [这里](/docs/developer_guide/develop_plugins/protocol.zh_CN.md),常见的第三方协议可以参考 [trpc-ecosystem/go-codec](https://github.com/trpc-ecosystem/go-codec)

**存储协议**

tRPC-Go 对常见数据库的访问做了封装,通过以服务访问的方式来进行数据库操作,具体可以参考 [tRPC-Go 调用存储服务](/docs/developer_guide/develop_plugins/storage_CN.md)
tRPC-Go 对常见数据库的访问做了封装,通过以服务访问的方式来进行数据库操作,具体可以参考 [tRPC-Go 调用存储服务](/docs/developer_guide/develop_plugins/storage.zh_CN.md)

**消息队列**

Expand Down Expand Up @@ -55,10 +55,10 @@ tRPC-Go 提供了对常见消息队列的生产者操作做了封装,通过以
tRPC-Go 除了为各种协议提供了接口调用外,还为服务的调用提供了丰富的服务治理能力,实现与服务治理组件的对接,开发人员只需要关注业务自身逻辑即可。框架通过插件可以实现以下服务治理能力:

- 服务寻址
- [调用超时控制](/docs/user_guide/timeout_control_zh_CN.md)
- [调用超时控制](/docs/user_guide/timeout_control.zh_CN.md)
- [拦截器机制](/docs/developer_guide/develop_plugins/interceptor_zh-CN.md),实现包括,调用链跟踪,监控上报,[重试对冲](https://github.com/trpc-ecosystem/go-filter/tree/main/slime)....
- [远程日志](/log/README_zh_CN.md)
- [配置中心](/config/README_zh_CN.md)
- [远程日志](/log/README.zh_CN.md)
- [配置中心](/config/README.zh_CN.md)
- ......

# 客户端开发
Expand Down Expand Up @@ -289,11 +289,11 @@ tRPC-Go 采用 GoDoc 来管理 tRPC-Go 框架 API 文档的。通过查阅 [tRPC

## 错误码

tRPC-Go 对错误码的数据类型和含义都做了规划,对于常见错误码的问题定位也都做了解释。具体请参考 [tRPC-Go 错误码手册](/docs/user_guide/error_codes_zh_cn.md)
tRPC-Go 对错误码的数据类型和含义都做了规划,对于常见错误码的问题定位也都做了解释。具体请参考 [tRPC-Go 错误码手册](/docs/user_guide/error_codes.zh_CN.md)

# 客户端配置

客户端配置可以通过框架配置文件中的“client”部分来配置,配置分为“全局服务配置”和“指定服务配置”。具体配置的含义,取值范围和默认值请参考 [tRPC-Go 框架配置](/docs/user_guide/framework_conf_zh_CN.md)
客户端配置可以通过框架配置文件中的“client”部分来配置,配置分为“全局服务配置”和“指定服务配置”。具体配置的含义,取值范围和默认值请参考 [tRPC-Go 框架配置](/docs/user_guide/framework_conf.zh_CN.md)

以下是 client 配置的一个典型示例:

Expand Down Expand Up @@ -478,7 +478,7 @@ func main() {
- 整体接口:名字服务作为整体注册到框架,作为一个 selector 插件。整体接口的优势在于注册到框架比较简单,框架不关心名字服务流程中各个模块的具体实现,插件可以整体控制名字服务寻址的整个流程,方便做性能优化和逻辑控制。
- 分模块接口:使用框架默认提供的 selector,服务发现、负载均衡、服务路由、熔断器等分别注册到框架,框架组合这些模块。分模块优势在于更加的灵活,用户可以根据自己的需要对不同模块进行选择然后自由组合,但同时会增加插件的实现复杂度。

框架支持用户开发新的名字服务插件。名字服务插件的开发请参考 [tRPC-Go 开发名字服务插件](/docs/developer_guide/develop_plugins/naming_zh_CN.md)。
框架支持用户开发新的名字服务插件。名字服务插件的开发请参考 [tRPC-Go 开发名字服务插件](/docs/developer_guide/develop_plugins/naming.zh_CN.md)。

# 插件选择

Expand Down Expand Up @@ -593,11 +593,11 @@ func (s *serverImpl) Call(ctx context.Context, req *pb.Req) (*pb.Rsp, error) {

## 超时控制

tRPC-Go 框架为服务的调用提供了调用超时机制。关于调用超时机制的介绍和相关配置,请参考 [tRPC-Go 超时控制](/docs/user_guide/timeout_control_zh_CN.md)
tRPC-Go 框架为服务的调用提供了调用超时机制。关于调用超时机制的介绍和相关配置,请参考 [tRPC-Go 超时控制](/docs/user_guide/timeout_control.zh_CN.md)

## 链路透传

tRPC-Go 框架提供在客户端与服务端之间透传字段,并在整个调用链路透传下去的机制。关于链路透传的机制和使用,请参考 [tRPC-Go 链路透传](/docs/user_guide/metadata_transmission_zh_CN.md)。此功能需要协议支持元数据下发功能,tRPC 协议,泛 HTTP RPC 协议,taf 协议均支持链路透传功能。其它协议请联系各自协议负责人。
tRPC-Go 框架提供在客户端与服务端之间透传字段,并在整个调用链路透传下去的机制。关于链路透传的机制和使用,请参考 [tRPC-Go 链路透传](/docs/user_guide/metadata_transmission.zh_CN.md)。此功能需要协议支持元数据下发功能,tRPC 协议,泛 HTTP RPC 协议,taf 协议均支持链路透传功能。其它协议请联系各自协议负责人。

## 自定义压缩

Expand Down
2 changes: 1 addition & 1 deletion docs/user_guide/framework_conf.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
English | [中文](./README_zh_CN.md)
English | [中文](./README.zh_CN.md)

# tRPC-Go Framework Configuration

Expand Down
File renamed without changes.
2 changes: 1 addition & 1 deletion docs/user_guide/graceful_restart.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
English | [中文](./graceful_restart_zh_CN.md)
English | [中文](./graceful_restart.zh_CN.md)

# Introduction

Expand Down
File renamed without changes.
2 changes: 1 addition & 1 deletion docs/user_guide/reverse_proxy.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
English | [中文](./reverse_proxy_zh_CN.md.md)
English | [中文](./reverse_proxy.zh_CN.md.md)

# tRPC-Go Reverse Proxy

Expand Down
File renamed without changes.
2 changes: 1 addition & 1 deletion docs/user_guide/server/flatbuffers.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
English | [中文](./flatbuffers_zh_CN.md)
English | [中文](./flatbuffers.zh_CN.md)

# Background

Expand Down
File renamed without changes.
2 changes: 1 addition & 1 deletion docs/user_guide/server/overview.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
English | [中文](./overview_zh_CN.md)
English | [中文](./overview.zh_CN.md)

tRPC-Go Server Development Guide

Expand Down
Loading

0 comments on commit 977210a

Please sign in to comment.