-
Notifications
You must be signed in to change notification settings - Fork 4k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Added autotranslated and cleanup english documentation #1654
base: master
Are you sure you want to change the base?
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There are two documents that are not translated
docs/en/flags.md
Outdated
@@ -0,0 +1,137 @@ | |||
brpc使用gflags管理配置。如果你的程序也使用gflags,那么你应该已经可以修改和brpc相关的flags,你可以浏览[flags服务](http://brpc.baidu.com:8765/flags)了解每个flag的具体功能。如果你的程序还没有使用gflags,我们建议你使用,原因如下: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This document is not translated
docs/en/nshead_service.md
Outdated
@@ -0,0 +1,230 @@ | |||
ub是百度内广泛使用的老RPC框架,在迁移ub服务时不可避免地需要[访问ub-server](ub_client.md)或被ub-client访问。ub使用的协议种类很多,但都以nshead作为二进制包的头部,这类服务在brpc中统称为**“nshead service”**。 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This document is not translated
Thanks for the review, done! |
Hi Martin, Thanks for the translation work. Since it's auto-translation, we need to check it manually and make sure there is no misunderstanding in English version. Could you please also read through the files and update them(or just comment) if they don't look natural to you? Jiashun |
Maybe we can add a notice at the beginning of the document, stating that this document is automatically translated? |
I did read them thru mostly and corrected a few major mistakes. Right now its the best i can do with my limited time. I could as @wwbmmm stated and add a notification that to the texts which are autotranslated. |
@Martin-Lierschof Ah I see. Adding a notice at the beginning would be great. |
@@ -0,0 +1,153 @@ | |||
# Adaptive current limit |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There're some specific translation that auto-translation cannot catch.
we should replace 'current limit' with Adaptive Load Shedding
|
||
In this way, when a node returns to overload, the client can initiate a retry to other nodes, so as not to lose traffic as much as possible. | ||
|
||
## How to open |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
How to turn on?
|
||
## Principle | ||
|
||
### noun |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Definitions / Terms ?
@@ -0,0 +1,159 @@ | |||
# introduce |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Introduction
|
||
The parameters needed to call the method should be placed in a Protobuf message. If the method returns a result, it should also be placed in a Protobuf message. The specific definition shall be agreed upon by the communicating parties. In particular, an empty Protobuf message can be used to indicate that the request/response is empty. | ||
|
||
## Bag |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
package
@@ -0,0 +1,23 @@ | |||
# background |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Background
|
||
ELF (Essential/Extreme/Excellent Learning Framework) framework provides learning/mining algorithm development support for big data applications inside and outside the company. The platform mainly includes framework support for iterative data processing, communication support during parallel computing, and a distributed, fast, and highly available parameter server for storing large-scale parameters. Used in fcr-model, public cloud bml, big data laboratory, voice technology department, etc. Previously it was based on the rpc packaged by [zeromq](http://zeromq.org/), this time I use brpc instead. | ||
|
||
# in conclusion |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Maybe we should replace all 'in conclusion' in heading with 'Summary'?
# Optional fusing strategy | ||
Relying only on the above-mentioned default circuit breaker strategy sometimes cannot fully meet the demand. Take an extreme example: if a downstream node logic thread is all stuck, but the io thread can work normally, then all requests will time out, but the tcp connection Can be established normally. For such situations, brpc provides a more radical fusing strategy on the basis of the default fusing strategy. After being turned on, brpc will determine whether the node is in a fault state based on the error rate. | ||
|
||
## How to open |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
turn on
@@ -0,0 +1,31 @@ | |||
brpc can analyze the time spent waiting for the lock and the functions that waited for. | |||
|
|||
# How to open |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
And we may need replace 'open' with 'turn on' in all places
@@ -0,0 +1,55 @@ | |||
Doing something at a few points is a basic requirement of the RPC framework, which is harder than it looks. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
at some certain time points
@Martin-Lierschof Hi, I skimmed through the translation and found something confusing that auto-translation didn't catch. Could you take another look? |
@@ -0,0 +1,64 @@ | |||
# Fuse function |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'm not sure if people can understand what fuse means here
Automatic translated missing Chinese documents and added them to the english version.