Refine docs #52
Refine docs #52
Conversation
LICENSE-MIT
Outdated
| @@ -0,0 +1,25 @@ | |||
| Copyright (c) 2023 ihciah, rainj-me and other Monolake Contributors | |||
There was a problem hiding this comment.
Copyright belongs to a ByteDance Group not Individuals. You may use CloudWeGo Contributors or Monolake contributors.
README.md
Outdated
| Monoio is a subproject of [CloudWeGo](https://www.cloudwego.io). | ||
|
|
||
| Due to the limit resource, any help to make the monolake more mature, reporting issues or requesting features are welcome. Refer the [Contributing](./CONTRIBUTING.md) documents for the guidelines. |
There was a problem hiding this comment.
Getting started page has the same content as the README. We could get rid of that page
There was a problem hiding this comment.
Try to keep it for the cloudwego wiki page.
docs/http_conn_reuse.png
Outdated
There was a problem hiding this comment.
Suggest we add X and Y axis labels to make the graphs more meaningful to the community
docs/monolake.md
Outdated
| @@ -0,0 +1,109 @@ | |||
| # Monolake, a proxy framework base on Rust and Iouring | |||
There was a problem hiding this comment.
nit: Change "Iouring" to follow official spelling of "io_uring" through the docs
docs/monolake.md
Outdated
| @@ -0,0 +1,109 @@ | |||
| # Monolake, a proxy framework base on Rust and Iouring | |||
|
|
|||
| Earlier 2023, Cloudflare released a blog to introduce their Oxy, a Rust-based modern proxy framework. We have the similar requirements at Volcano Engine (a public cloud from Bytedance Inc.), so we start Monolake project, a layer 4/7 proxy framework base on Rust and Iouring. | |||
There was a problem hiding this comment.
Suggestion: We avoid mentioning Oxy, another project, in the first line of Monolake docs. If we do decide to mention it, we be more specific about what exactly our requirements are or what specifically in Oxy inspired us
docs/monolake.md
Outdated
|
|
||
| ## Architecture of Monolake | ||
|
|
||
| There are 3 major categories in monolake, the runtime & transport, the tls and the http. Monolake currently supoprt Iouring and epoll runtime which are benefit from monoio(a thread-per-core rust runtime). The layer 4 proxy is implemented in monolake. The tls category currently support both rustls and native-tls, user can switch between these two solutions in case there is critical security defect in one of them. For the http category, monolake support http/1.1 and h2, we are currently working on the thrift protocol support, the grpc and h3 protocol support is planned. |
There was a problem hiding this comment.
Suggestion: It's not very obvious what "Transport" means at first glance here. If my understanding is correct, its the features that monolake proxy framework provides like dynamic handler chain update, metrics e.t.c.
We could have 4 components: Runtime, Proxy Infra, TLS and HTTP
What type of PR is this?
Check the PR title.
(Optional) Translate the PR title into Chinese.
(Optional) More detailed description for this PR(en: English/zh: Chinese).
en:
zh(optional):
(Optional) Which issue(s) this PR fixes:
(optional) The PR that updates user documentation: