docs: move en<->cn switch to right places (trpc-group#70)

close trpc-group#61
lin-credible · Oct 12, 2023 · 78d59eb · 78d59eb
1 parent 20de994
commit 78d59eb
Show file tree

Hide file tree

Showing 58 changed files with 95 additions and 106 deletions.
diff --git a/README.md b/README.md
@@ -1,3 +1,5 @@
+English | [中文](README.zh_CN.md)
+
 # tRPC-Go Framework
 
 [![Go Reference](https://pkg.go.dev/badge/github.com/trpc.group/trpc-go.svg)](https://pkg.go.dev/github.com/trpc.group/trpc-go)
@@ -8,7 +10,6 @@
 [![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.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.
 

diff --git a/README.zh_CN.md b/README.zh_CN.md
@@ -1,3 +1,5 @@
+[English](README.md) | 中文
+
 # tRPC-Go Framework
 
 [![Go Reference](https://pkg.go.dev/badge/github.com/trpc.group/trpc-go.svg)](https://pkg.go.dev/github.com/trpc.group/trpc-go)
@@ -8,7 +10,6 @@
 [![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.md) | 中文
 
 tRPC-Go，作为 [tRPC][] 的 [Go][] 语言版本，是经过大规模线上业务使用验证过的微服务框架，它不仅性能高，而且易于使用和测试。
 

diff --git a/admin/README.md b/admin/README.md
@@ -1,4 +1,4 @@
-English | [中文](./README.zh_CN.md)
+English | [中文](README.zh_CN.md)
 
 # Introduction
 

diff --git a/admin/README.zh_CN.md b/admin/README.zh_CN.md
@@ -1,4 +1,4 @@
-[English](./README.md) | 中文
+[English](README.md) | 中文
 
 # 前言
 

diff --git a/client/README.md b/client/README.md
@@ -1,6 +1,7 @@
+English | [中文](README.zh_CN.md)
+
 # tRPC-Go Client Package
 
-English | [中文](README.zh_CN.md)
 
 ## Background
 

diff --git a/client/README.zh_CN.md b/client/README.zh_CN.md
@@ -1,6 +1,7 @@
+[English](README.md) | 中文
+
 # tRPC-Go Client 模块
 
-[English](README.md) | 中文
 
 ## 背景
 

diff --git a/codec/README.md b/codec/README.md
@@ -1,4 +1,5 @@
 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.

diff --git a/codec/README.zh_CN.md b/codec/README.zh_CN.md
@@ -1,4 +1,5 @@
 [English](README.md) | 中文
+
 # codec
 
 `codec` 包可以支持任意的第三方业务通信协议，只需要实现相关接口即可。

diff --git a/config/README.md b/config/README.md
@@ -1,4 +1,4 @@
-English | [中文](./README.zh_CN.md)
+English | [中文](README.zh_CN.md)
 
 # Introduction
 

diff --git a/config/README.zh_CN.md b/config/README.zh_CN.md
@@ -1,4 +1,4 @@
-[English](./README.md) | 中文
+[English](README.md) | 中文
 
 # 前言
 

diff --git a/docs/developer_guide/develop_plugins/database.md b/docs/developer_guide/develop_plugins/database.md
@@ -1,4 +1,4 @@
-English | [中文](database_zh_CN.md)
+English | [中文](database.zh_CN.md)
 
 # How to Develop a Database Plugin
 

diff --git a/docs/developer_guide/develop_plugins/log.md b/docs/developer_guide/develop_plugins/log.md
@@ -1,3 +1,5 @@
+English | [中文](log.zh_CN.md)
+
 # How to Develop a Writer Plugin for Log plugin
 
 The log package provides a log plugin named "default", which supports configuring multiple Writers in a pluginized manner. 

diff --git a/docs/developer_guide/develop_plugins/log.zh_CN.md b/docs/developer_guide/develop_plugins/log.zh_CN.md
@@ -1,3 +1,5 @@
+[English](log.md) | 中文
+
 # 怎么为 log 类型的插件开发一个 Writer 插件 
 
 `log` 包提供了一个名为 “default” 的 log 插件， 该插件支持以插件的形式配置多个 Writer。

diff --git a/docs/developer_guide/develop_plugins/metrics.md b/docs/developer_guide/develop_plugins/metrics.md
@@ -1,3 +1,5 @@
+English | [中文](metrics.zh_CN.md)
+
 # How to develop a metric type plugin
 
 This guide will introduce how to develop a metric type plugin that depends on configuration for loading.

diff --git a/docs/developer_guide/develop_plugins/metrics.zh_CN.md b/docs/developer_guide/develop_plugins/metrics.zh_CN.md
@@ -1,3 +1,5 @@
+[English](metrics.md) | 中文
+
 # 怎么开发一个 metric 类型的插件
 
 本指南将介绍如何开发一个依赖配置进行加载的 metric 类型的插件。

diff --git a/docs/quick_start.md b/docs/quick_start.md
@@ -1,6 +1,7 @@
+English | [中文](quick_start.zh_CN.md)
+
 # Quick Start
 
-English | [中文](quick_start.zh_CN.md)
 
 ## Prerequisites
 

diff --git a/docs/quick_start.zh_CN.md b/docs/quick_start.zh_CN.md
@@ -1,6 +1,7 @@
+[English](quick_start.md) | 中文
+
 # 快速上手
 
-[English](quick_start.md) | 中文
 
 ## 安装依赖
 

diff --git a/docs/user_guide/attachment.md b/docs/user_guide/attachment.md
@@ -1,3 +1,5 @@
+English | [中文](attachment.zh_CN.md)
+
 #  tRPC-Go Attachment (Large Binary Data) Transmission
 
 tRPC protocol now supports sending attachments over simple RPC.

diff --git a/docs/user_guide/attachment.zh_CN.md b/docs/user_guide/attachment.zh_CN.md
@@ -1,3 +1,5 @@
+[English](attachment.md) | 中文
+
 # tRPC-Go 附件（大二进制数据）传输
 
 tRPC 协议支持通过简单 RPC 发送附件。

diff --git a/docs/user_guide/client/connection_mode.md b/docs/user_guide/client/connection_mode.md
@@ -1,6 +1,7 @@
+English | [中文](connection_mode.zh_CN.md)
+
 # tRPC-Go client connection mode
 
-English | [中文](./connection_mode.zh_CN.md)
 
 ## Introduction
 

diff --git a/docs/user_guide/client/connection_mode.zh_CN.md b/docs/user_guide/client/connection_mode.zh_CN.md
@@ -1,6 +1,7 @@
+[English](connection_mode.md) | 中文
+
 # tRPC-Go 客户端连接模式
 
-[English](./connection_mode.md) | 中文
 
 # 前言
 

diff --git a/docs/user_guide/client/flatbuffers.md b/docs/user_guide/client/flatbuffers.md
@@ -1,4 +1,4 @@
-English | [中文](./flatbuffers.zh_CN.md)
+English | [中文](flatbuffers.zh_CN.md)
 
 # Introduction
 

diff --git a/docs/user_guide/client/flatbuffers.zh_CN.md b/docs/user_guide/client/flatbuffers.zh_CN.md
@@ -1,4 +1,4 @@
-[English](./flatbuffers.md) | 中文
+[English](flatbuffers.md) | 中文
 
 # 前言
 

diff --git a/docs/user_guide/client/overview.md b/docs/user_guide/client/overview.md
@@ -1,6 +1,7 @@
+English | [中文](overview.zh_CN.md)
+
 tRPC-Go Client Development Guide
 
-English | [中文](overview.zh_CN.md)
 
 # Introduction
 

diff --git a/docs/user_guide/client/overview.zh_CN.md b/docs/user_guide/client/overview.zh_CN.md
@@ -1,7 +1,7 @@
-tRPC-Go 客户端开发向导
-
 [English](overview.md) | 中文
 
+tRPC-Go 客户端开发向导
+
 # 前言
 
 tRPC-Go 框架和插件为服务提供了接口调用，用户可以像调用本地函数一样来调用下游服务，而不用关心底层实现细节。本文首先通过对服务调用的整个处理流程的梳理，来介绍框架为服务调用能提供哪些能力，用户可以采用哪些手段来控制服务调用各个环节的行为。接下来，本文会从服务调用，配置，寻址，拦截器，协议选择等关键环节来阐述如何开发和配置一个客户端调用。文章会就服务调用的典型场景为用户提供开发指导，尤其是程序既作为服务端又作为客户端的场景。

diff --git a/docs/user_guide/framework_conf.md b/docs/user_guide/framework_conf.md
@@ -1,4 +1,4 @@
-English | [中文](./README.zh_CN.md)
+English | [中文](framework_conf.zh_CN.md)
 
 # tRPC-Go Framework Configuration
 

diff --git a/docs/user_guide/framework_conf.zh_CN.md b/docs/user_guide/framework_conf.zh_CN.md
@@ -1,4 +1,4 @@
-[English](./README.md) | 中文
+[English](framework_conf.md) | 中文
 
 # tRPC-Go 框架配置
 

diff --git a/docs/user_guide/graceful_restart.md b/docs/user_guide/graceful_restart.md
@@ -1,4 +1,4 @@
-English | [中文](./graceful_restart.zh_CN.md)
+English | [中文](graceful_restart.zh_CN.md)
 
 # Introduction
 

diff --git a/docs/user_guide/graceful_restart.zh_CN.md b/docs/user_guide/graceful_restart.zh_CN.md
@@ -1,4 +1,4 @@
-[English](./graceful_restart.md) | 中文
+[English](graceful_restart.md) | 中文
 
 # 前言
 

diff --git a/docs/user_guide/metadata_transmission.md b/docs/user_guide/metadata_transmission.md
@@ -1,3 +1,5 @@
+English | [中文](metadata_transmission.zh_CN.md)
+
 # tRPC-Go metadata transmission
 
 ## Introduction

diff --git a/docs/user_guide/metadata_transmission.zh_CN.md b/docs/user_guide/metadata_transmission.zh_CN.md
@@ -1,3 +1,5 @@
+[English](metadata_transmission.md) | 中文
+
 # tRPC-Go 链路透传
 
 ## 前言

diff --git a/docs/user_guide/reverse_proxy.md b/docs/user_guide/reverse_proxy.md
@@ -1,4 +1,4 @@
-English | [中文](./reverse_proxy.zh_CN.md.md)
+English | [中文](reverse_proxy.zh_CN.md)
 
 # tRPC-Go Reverse Proxy
 

diff --git a/docs/user_guide/reverse_proxy.zh_CN.md b/docs/user_guide/reverse_proxy.zh_CN.md
@@ -1,4 +1,4 @@
-[English](./reverse_proxy.md) | 中文
+[English](reverse_proxy.md) | 中文
 
 # tRPC-Go 反向代理
 

diff --git a/docs/user_guide/server/flatbuffers.md b/docs/user_guide/server/flatbuffers.md
@@ -1,4 +1,4 @@
-English | [中文](./flatbuffers.zh_CN.md)
+English | [中文](flatbuffers.zh_CN.md)
 
 # Background
 

diff --git a/docs/user_guide/server/flatbuffers.zh_CN.md b/docs/user_guide/server/flatbuffers.zh_CN.md
@@ -1,4 +1,4 @@
-[English](./flatbuffers.md) | 中文
+[English](flatbuffers.md) | 中文
 
 # 背景
 

diff --git a/docs/user_guide/server/overview.md b/docs/user_guide/server/overview.md
@@ -1,4 +1,4 @@
-English | [中文](./overview.zh_CN.md)
+English | [中文](overview.zh_CN.md)
 
 tRPC-Go Server Development Guide
 

diff --git a/docs/user_guide/server/overview.zh_CN.md b/docs/user_guide/server/overview.zh_CN.md
@@ -1,4 +1,4 @@
-[English](./overview.md) | 中文
+[English](overview.md) | 中文
 
 tRPC-Go 服务端开发向导
 

diff --git a/docs/user_guide/timeout_control.md b/docs/user_guide/timeout_control.md
@@ -1,3 +1,5 @@
+English | [中文](timeout_control.zh_CN.md)
+
 # tRPC-Go Timeout Control
 
 ## Introduction

diff --git a/docs/user_guide/timeout_control.zh_CN.md b/docs/user_guide/timeout_control.zh_CN.md
@@ -1,3 +1,5 @@
+[English](timeout_control.md) | 中文
+
 # tRPC-Go 超时控制
 
 ## 前言

diff --git a/docs/user_guide/tnet.md b/docs/user_guide/tnet.md
@@ -1,6 +1,7 @@
+English | [中文](tnet.zh_CN.md)
+
 # Using high-performance networking framework tnet with tRPC-Go
 
-English | [中文](./tnet.zh_CN.md)
 
 ## Introduction
 

diff --git a/docs/user_guide/tnet.zh_CN.md b/docs/user_guide/tnet.zh_CN.md
@@ -1,6 +1,7 @@
+[English](tnet.md) | 中文
+
 # tRPC-Go 接入高性能网络库 tnet
 
-[English](./tnet.md) | 中文
 
 ## 前言
 

diff --git a/errs/README.md b/errs/README.md
@@ -1,6 +1,7 @@
+English | [中文](README.zh_CN.md)
+
 # tRPC-Go Error Code Definition
 
-English | [中文](./README.zh_CN.md)
 
 ## Introduction
 

diff --git a/errs/README.zh_CN.md b/errs/README.zh_CN.md
@@ -1,6 +1,7 @@
+[English](README.md) | 中文
+
 # tRPC-Go 错误码定义
 
-[English](./README.md) | 中文
 
 ## 前言
 

diff --git a/filter/README.md b/filter/README.md
@@ -1,6 +1,7 @@
+English | [中文](README.zh_CN.md)
+
 # tRPC-Go Development of Filter
 
-English | [中文](README.zh_CN.md)
 
 ## Introduction
 

diff --git a/filter/README.zh_CN.md b/filter/README.zh_CN.md
@@ -1,6 +1,7 @@
+[English](README.md) | 中文
+
 # tRPC-Go 开发拦截器插件
 
-[English](README.md) | 中文
 
 ## 前言
 

diff --git a/healthcheck/README.md b/healthcheck/README.md
@@ -1,4 +1,4 @@
-English | [中文](./README.zh_CN.md)
+English | [中文](README.zh_CN.md)
 
 ## Introduction
 

diff --git a/healthcheck/README.zh_CN.md b/healthcheck/README.zh_CN.md
@@ -1,4 +1,4 @@
-[English](./README.md) | 中文
+[English](README.md) | 中文
 
 ## 前言
 

diff --git a/http/README.md b/http/README.md
@@ -1,36 +1,6 @@
-- [tRPC-Go HTTP protocol 中文主页](#trpc-go-http-protocol-中文主页)
-  - [Pan-HTTP standard services](#pan-http-standard-services)
-    - [Server-side](#server-side)
-      - [configuration writing](#configuration-writing)
-      - [code writing](#code-writing)
-        - [single URL registration](#single-url-registration)
-        - [MUX Registration](#mux-registration)
-    - [Client](#client)
-      - [configuration writing](#configuration-writing-1)
-      - [code writing](#code-writing-1)
-  - [Pan HTTP RPC Service](#pan-http-rpc-service)
-    - [Server-side](#server-side-1)
-      - [configuration writing](#configuration-writing-2)
-      - [code writing](#code-writing-2)
-      - [Custom URL path](#custom-url-path)
-      - [Custom error code handling functions](#custom-error-code-handling-functions)
-    - [Client](#client-1)
-      - [configuration writing](#configuration-writing-3)
-      - [code writing](#code-writing-3)
-  - [FAQ](#faq)
-    - [Enable HTTPS for Client and Server](#enable-https-for-client-and-server)
-      - [Mutual Authentication](#mutual-authentication)
-        - [Configuration Only](#configuration-only)
-        - [Code Only](#code-only)
-      - [Client Certificate Not Authenticated](#client-certificate-not-authenticated)
-        - [Configuration Only](#configuration-only-1)
-        - [Code Only](#code-only-1)
-    - [Client uses `io.Reader` for streaming file upload](#client-uses-ioreader-for-streaming-file-upload)
-    - [Reading Response Body Stream Using io.Reader in the Client](#reading-response-body-stream-using-ioreader-in-the-client)
-    - [Client and Server Sending and Receiving HTTP Chunked](#client-and-server-sending-and-receiving-http-chunked)
-
-
-# tRPC-Go HTTP protocol [中文主页](README.zh_CN.md)
+English | [中文](README.zh_CN.md)
+
+# tRPC-Go HTTP protocol 
 
 The tRPC-Go framework supports building three types of HTTP-related services: