Skip to content

Commit be01d10

Browse files
docs(readme): update READMEs and add English doc placeholders (#3263)
- Fix outdated Travis CI badge in README_cn.md to GitHub Actions - Unify all doc links in README.md to point to docs/en/ directory - Add references for bthread tracer, coroutine, circuit breaker, RDMA, Bazel support - Create 39 English placeholder docs pointing to Chinese versions - Create Chinese placeholder for couchbase_example
1 parent d269b69 commit be01d10

42 files changed

Lines changed: 328 additions & 36 deletions

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

README.md

Lines changed: 42 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -18,34 +18,36 @@ You can use it to:
1818
* hadoop_rpc (may be opensourced)
1919
* [rdma](https://en.wikipedia.org/wiki/Remote_direct_memory_access) support
2020
* [thrift](docs/en/thrift.md) support, thread-safe, more friendly and performant than the official clients.
21-
* all sorts of protocols used in Baidu: [baidu_std](docs/cn/baidu_std.md), [streaming_rpc](docs/en/streaming_rpc.md), hulu_pbrpc, [sofa_pbrpc](https://github.com/baidu/sofa-pbrpc), nova_pbrpc, public_pbrpc, ubrpc and nshead-based ones.
21+
* all sorts of protocols used in Baidu: [baidu_std](docs/en/baidu_std.md), [streaming_rpc](docs/en/streaming_rpc.md), hulu_pbrpc, [sofa_pbrpc](https://github.com/baidu/sofa-pbrpc), nova_pbrpc, public_pbrpc, ubrpc and nshead-based ones.
2222
* Build [HA](https://en.wikipedia.org/wiki/High_availability) distributed services using an industrial-grade implementation of [RAFT consensus algorithm](https://raft.github.io) which is opensourced at [braft](https://github.com/brpc/braft)
2323
* Servers can handle requests [synchronously](docs/en/server.md) or [asynchronously](docs/en/server.md#asynchronous-service).
2424
* Clients can access servers [synchronously](docs/en/client.md#synchronus-call), [asynchronously](docs/en/client.md#asynchronous-call), [semi-synchronously](docs/en/client.md#semi-synchronous-call), or use [combo channels](docs/en/combo_channel.md) to simplify sharded or parallel accesses declaratively.
25-
* Debug services [via http](docs/en/builtin_service.md), and run [cpu](docs/cn/cpu_profiler.md), [heap](docs/cn/heap_profiler.md) and [contention](docs/cn/contention_profiler.md) profilers.
25+
* Debug services [via http](docs/en/builtin_service.md), and run [cpu](docs/en/cpu_profiler.md), [heap](docs/en/heap_profiler.md) and [contention](docs/en/contention_profiler.md) profilers.
2626
* Get [better latency and throughput](docs/en/overview.md#better-latency-and-throughput).
27-
* [Extend bRPC](docs/en/new_protocol.md) with the protocols used in your organization quickly, or customize components, including [naming services](docs/cn/load_balancing.md#命名服务) (dns, zk, etcd), [load balancers](docs/cn/load_balancing.md#负载均衡) (rr, random, consistent hashing)
27+
* [Extend bRPC](docs/en/new_protocol.md) with the protocols used in your organization quickly, or customize components, including [naming services](docs/en/load_balancing.md) (dns, zk, etcd), [load balancers](docs/en/load_balancing.md) (rr, random, consistent hashing)
2828

2929
# Try it!
3030

3131
* Read [overview](docs/en/overview.md) to know where bRPC can be used and its advantages.
32-
* Read [getting started](docs/cn/getting_started.md) for building steps and play with [examples](https://github.com/apache/brpc/tree/master/example/).
32+
* Read [getting started](docs/en/getting_started.md) for building steps and play with [examples](https://github.com/apache/brpc/tree/master/example/).
3333
* Docs:
34-
* [Performance benchmark](docs/cn/benchmark.md)
34+
* [Performance benchmark](docs/en/benchmark.md)
3535
* [bvar](docs/en/bvar.md)
36-
* [bvar_c++](docs/cn/bvar_c++.md)
37-
* [bthread](docs/cn/bthread.md)
38-
* [bthread or not](docs/cn/bthread_or_not.md)
39-
* [thread-local](docs/cn/thread_local.md)
40-
* [Execution Queue](docs/cn/execution_queue.md)
36+
* [bvar_c++](docs/en/bvar_c++.md)
37+
* [bthread](docs/en/bthread.md)
38+
* [bthread or not](docs/en/bthread_or_not.md)
39+
* [thread-local](docs/en/thread_local.md)
40+
* [Execution Queue](docs/en/execution_queue.md)
41+
* [bthread tracer](docs/en/bthread_tracer.md)
42+
* [bthread tagged task group](docs/en/bthread_tagged_task_group.md)
4143
* Client
4244
* [Basics](docs/en/client.md)
4345
* [Error code](docs/en/error_code.md)
4446
* [Combo channels](docs/en/combo_channel.md)
4547
* [Access http/h2](docs/en/http_client.md)
4648
* [Access gRPC](docs/en/http_derivatives.md#h2grpc)
47-
* [Access thrift](docs/en/thrift.md#client-accesses-thrift-server)
48-
* [Access UB](docs/cn/ub_client.md)
49+
* [Access thrift](docs/en/thrift.md#client-accesses-thrift-server)
50+
* [Access UB](docs/en/ub_client.md)
4951
* [Streaming RPC](docs/en/streaming_rpc.md)
5052
* [Access redis](docs/en/redis_client.md)
5153
* [Access memcached](docs/en/memcache_client.md)
@@ -56,32 +58,37 @@ You can use it to:
5658
* [Serve http/h2](docs/en/http_service.md)
5759
* [Serve gRPC](docs/en/http_derivatives.md#h2grpc)
5860
* [Serve thrift](docs/en/thrift.md#server-processes-thrift-requests)
59-
* [Serve Nshead](docs/cn/nshead_service.md)
60-
* [Debug server issues](docs/cn/server_debugging.md)
61+
* [Serve Nshead](docs/en/nshead_service.md)
62+
* [Debug server issues](docs/en/server_debugging.md)
6163
* [Server push](docs/en/server_push.md)
62-
* [Avalanche](docs/cn/avalanche.md)
63-
* [Auto ConcurrencyLimiter](docs/cn/auto_concurrency_limiter.md)
64+
* [Avalanche](docs/en/avalanche.md)
65+
* [Auto ConcurrencyLimiter](docs/en/auto_concurrency_limiter.md)
6466
* [Media Server](https://github.com/brpc/media-server)
65-
* [json2pb](docs/cn/json2pb.md)
67+
* [json2pb](docs/en/json2pb.md)
6668
* [Builtin Services](docs/en/builtin_service.md)
6769
* [status](docs/en/status.md)
6870
* [vars](docs/en/vars.md)
69-
* [connections](docs/cn/connections.md)
70-
* [flags](docs/cn/flags.md)
71-
* [rpcz](docs/cn/rpcz.md)
72-
* [cpu_profiler](docs/cn/cpu_profiler.md)
73-
* [heap_profiler](docs/cn/heap_profiler.md)
74-
* [contention_profiler](docs/cn/contention_profiler.md)
71+
* [connections](docs/en/connections.md)
72+
* [flags](docs/en/flags.md)
73+
* [rpcz](docs/en/rpcz.md)
74+
* [cpu_profiler](docs/en/cpu_profiler.md)
75+
* [heap_profiler](docs/en/heap_profiler.md)
76+
* [contention_profiler](docs/en/contention_profiler.md)
7577
* Tools
76-
* [rpc_press](docs/cn/rpc_press.md)
77-
* [rpc_replay](docs/cn/rpc_replay.md)
78-
* [rpc_view](docs/cn/rpc_view.md)
79-
* [benchmark_http](docs/cn/benchmark_http.md)
80-
* [parallel_http](docs/cn/parallel_http.md)
78+
* [rpc_press](docs/en/rpc_press.md)
79+
* [rpc_replay](docs/en/rpc_replay.md)
80+
* [rpc_view](docs/en/rpc_view.md)
81+
* [benchmark_http](docs/en/benchmark_http.md)
82+
* [parallel_http](docs/en/parallel_http.md)
8183
* Others
8284
* [IOBuf](docs/en/iobuf.md)
8385
* [Streaming Log](docs/en/streaming_log.md)
84-
* [FlatMap](docs/cn/flatmap.md)
86+
* [FlatMap](docs/en/flatmap.md)
87+
* [Coroutine](docs/en/coroutine.md)
88+
* [Circuit Breaker](docs/en/circuit_breaker.md)
89+
* [RDMA](docs/en/rdma.md)
90+
* [Bazel Support](docs/en/bazel_support.md)
91+
* [Wireshark baidu_std dissector plugin](docs/en/wireshark_baidu_std.md)
8592
* [bRPC introduction](docs/cn/brpc_intro.pptx)(training material)
8693
* [A tutorial on building large-scale services](docs/en/tutorial_on_building_services.pptx)(training material)
8794
* [bRPC internal](docs/en/brpc_internal.pptx)(training material)
@@ -90,12 +97,12 @@ You can use it to:
9097
* [Atomic instructions](docs/en/atomic_instructions.md)
9198
* [IO](docs/en/io.md)
9299
* [Threading Overview](docs/en/threading_overview.md)
93-
* [Load Balancing](docs/cn/load_balancing.md)
94-
* [Locality-aware](docs/cn/lalb.md)
95-
* [Consistent Hashing](docs/cn/consistent_hashing.md)
96-
* [Memory Management](docs/cn/memory_management.md)
97-
* [Timer keeping](docs/cn/timer_keeping.md)
98-
* [bthread_id](docs/cn/bthread_id.md)
100+
* [Load Balancing](docs/en/load_balancing.md)
101+
* [Locality-aware](docs/en/lalb.md)
102+
* [Consistent Hashing](docs/en/consistent_hashing.md)
103+
* [Memory Management](docs/en/memory_management.md)
104+
* [Timer keeping](docs/en/timer_keeping.md)
105+
* [bthread_id](docs/en/bthread_id.md)
99106
* Use cases
100107
* [User cases](community/cases.md)
101108

README_cn.md

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
[English version](README.md)
22

3-
[![Build Status](https://api.travis-ci.com/apache/brpc.svg?branch=master)](https://travis-ci.com/github/apache/brpc)
3+
[![Linux Build Status](https://github.com/apache/brpc/actions/workflows/ci-linux.yml/badge.svg)](https://github.com/apache/brpc/actions/workflows/ci-linux.yml)
4+
[![MacOs Build Status](https://github.com/apache/brpc/actions/workflows/ci-macos.yml/badge.svg)](https://github.com/apache/brpc/actions/workflows/ci-macos.yml)
45

56
![brpc logo (light)](docs/images/logo.png#gh-light-mode-only)
67
![brpc logo (dark)](docs/images/logo-white.png#gh-dark-mode-only)
@@ -39,6 +40,7 @@
3940
* [thread-local](docs/cn/thread_local.md)
4041
* [Execution Queue](docs/cn/execution_queue.md)
4142
* [bthread tracer](docs/cn/bthread_tracer.md)
43+
* [bthread tagged task group](docs/cn/bthread_tagged_task_group.md)
4244
* Client
4345
* [基础功能](docs/cn/client.md)
4446
* [错误码](docs/cn/error_code.md)
@@ -83,6 +85,11 @@
8385
* [IOBuf](docs/cn/iobuf.md)
8486
* [Streaming Log](docs/cn/streaming_log.md)
8587
* [FlatMap](docs/cn/flatmap.md)
88+
* [协程](docs/cn/coroutine.md)
89+
* [熔断](docs/cn/circuit_breaker.md)
90+
* [RDMA](docs/cn/rdma.md)
91+
* [Bazel构建支持](docs/cn/bazel_support.md)
92+
* [Wireshark baidu_std协议解析插件](docs/cn/wireshark_baidu_std.md)
8693
* [bRPC外功修炼宝典](docs/cn/brpc_intro.pptx)(培训材料)
8794
* [搭建大型服务入门](docs/en/tutorial_on_building_services.pptx)(培训材料)
8895
* [bRPC内功修炼宝典](docs/en/brpc_internal.pptx)(培训材料)

docs/cn/couchbase_example.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
# Couchbase 示例
2+
3+
本文档尚未翻译为中文。
4+
5+
请参阅[英文版](../en/couchbase_example.md)获取完整内容。
Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
# auto concurrency limiter
2+
3+
This document has not yet been translated into English.
4+
5+
Please refer to the [Chinese version](../cn/auto_concurrency_limiter.md) for the full content.
6+
7+
Contributions to translate this document are welcome. See [TRANSLATING](TRANSLATING) for guidelines.

docs/en/baidu_std.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
# uaidu std
2+
3+
This document has not yet been translated into English.
4+
5+
Please refer to the [Chinese version](../cn/baidu_std.md) for the full content.
6+
7+
Contributions to translate this document are welcome. See [TRANSLATING](TRANSLATING) for guidelines.

docs/en/benchmark.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
# uenchmark
2+
3+
This document has not yet been translated into English.
4+
5+
Please refer to the [Chinese version](../cn/benchmark.md) for the full content.
6+
7+
Contributions to translate this document are welcome. See [TRANSLATING](TRANSLATING) for guidelines.

docs/en/benchmark_http.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
# uenchmark http
2+
3+
This document has not yet been translated into English.
4+
5+
Please refer to the [Chinese version](../cn/benchmark_http.md) for the full content.
6+
7+
Contributions to translate this document are welcome. See [TRANSLATING](TRANSLATING) for guidelines.

docs/en/bthread.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
# uthread
2+
3+
This document has not yet been translated into English.
4+
5+
Please refer to the [Chinese version](../cn/bthread.md) for the full content.
6+
7+
Contributions to translate this document are welcome. See [TRANSLATING](TRANSLATING) for guidelines.

docs/en/bthread_id.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
# uthread id
2+
3+
This document has not yet been translated into English.
4+
5+
Please refer to the [Chinese version](../cn/bthread_id.md) for the full content.
6+
7+
Contributions to translate this document are welcome. See [TRANSLATING](TRANSLATING) for guidelines.

docs/en/bthread_or_not.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
# uthread or not
2+
3+
This document has not yet been translated into English.
4+
5+
Please refer to the [Chinese version](../cn/bthread_or_not.md) for the full content.
6+
7+
Contributions to translate this document are welcome. See [TRANSLATING](TRANSLATING) for guidelines.

0 commit comments

Comments
 (0)