update and format docs

.cargo/config.toml

@@ -1,4 +1,3 @@
-
 [target.'cfg(target_arch = "x86_64")']
 rustflags = [
     "-C", "target-cpu=x86-64-v2",

.github/dependabot.yml

@@ -1,4 +1,3 @@
-
 version: 2
 updates:
   - package-ecosystem: cargo

CHANGELOG.md

@@ -1,4 +1,3 @@
-
 Each component have its own changelog.
 
 - [g3proxy](g3proxy/CHANGELOG)

README.ja_JP.md

@@ -46,16 +46,18 @@ G3 プロジェクトには多くのコンポーネントが含まれており
 
 詳しい機能紹介とユーザーガイドは[g3proxy](g3proxy/README.md)をご覧ください。
 
-Sphinx を使用して生成された g3proxy リファレンス ドキュメントは、[Read the Docs](https://g3-project.readthedocs.io/projects/g3proxy/en/latest/)
-でオンラインで参照できます。 詳細な設定形式、ログ形式、監視管理定義、プロトコル定義などを含みます。
+Sphinx を使用して生成された g3proxy リファレンス
+ドキュメントは、[Read the Docs](https://g3-project.readthedocs.io/projects/g3proxy/en/latest/)
+でオンラインで参照できます。 詳細な設定形式、ログ形式、メトリクスの定義、メトリクスの定義などを含みます。
 
 ### g3tiles
 
 作業中のリバースプロキシソリューション。
 
-Sphinx を使用して生成された g3tiles リファレンス ドキュメントは、[Read the Docs](https://g3-project.readthedocs.io/projects/g3tiles/en/latest/)
+Sphinx を使用して生成された g3tiles リファレンス
+ドキュメントは、[Read the Docs](https://g3-project.readthedocs.io/projects/g3tiles/en/latest/)
 でオンラインで参照できます。
-詳細な設定形式、ログ形式、監視管理定義などを含みます。
+詳細な設定形式、ログ形式、メトリクスの定義などを含みます。
 
 ### g3bench
 

README.md

@@ -13,7 +13,8 @@ including but not limited to proxy / reverse proxy (WIP) / load balancer (TBD) /
 
 ## Components
 
-The G3 project contains many components, each of which has a separate subdirectory containing its own code, documentation, etc.
+The G3 project contains many components, each of which has a separate subdirectory containing its own code,
+documentation, etc.
 
 In addition to the component directories, there are some public directories:
 
@@ -46,17 +47,17 @@ as we have basic support built in.
 
 See [g3proxy](g3proxy/README.md) for detailed introduction and user guide docs.
 
-You can view the g3proxy reference documentation generated by sphinx online at 
+You can view the g3proxy reference documentation generated by sphinx online at
 [Read the Docs](https://g3-project.readthedocs.io/projects/g3proxy/en/latest/),
-including detailed configuration format, log format, monitoring point definition, protocol definition, etc.
+including detailed configuration format, log format, metrics definition, protocol definition, etc.
 
 ### g3tiles
 
 A work in progress reverse proxy solution.
 
 You can view the g3tiles reference documentation generated by sphinx online at
 [Read the Docs](https://g3-project.readthedocs.io/projects/g3tiles/en/latest/),
-including detailed configuration format, log format, monitoring point definition, etc.
+including detailed configuration format, log format, metrics definition, etc.
 
 ### g3bench
 

README.zh_CN.md

@@ -43,7 +43,7 @@ G3项目包含许多组件，每一个组件单独一个子目录，包含各自
 - 多种日志 & 监控解决方案集成能力
 
 详细功能介绍及用户指南请看 [g3proxy](g3proxy/README.md)。
- 
+
 可在 [Read the Docs](https://g3-project.readthedocs.io/projects/g3proxy/en/latest/) 线上查看使用sphinx生成的g3proxy参考文档，
 包括详细配置格式、日志格式、监控打点定义、协议定义等。
 

doc/dev-setup.md

@@ -1,5 +1,6 @@
 Dev-Setup
 -----
+
 # Toolchain
 
 ## Install rustup
@@ -34,50 +35,57 @@ rustup self update
 ## Install stable toolchains
 
 List all available components:
+
 ```shell
 rustup component list
 ```
 
 The following components is required and should have already been installed:
 
- - rustc
- - rust-std
- - cargo
- - rustfmt
- - clippy
+- rustc
+- rust-std
+- cargo
+- rustfmt
+- clippy
 
 **llvm-tools** is also recommended to be installed:
+
 ```shell script
 rustup component add llvm-tools
 ```
 
 ## Install nightly toolchains
 
 Install nightly toolchains:
+
 ```shell script
 rustup toolchain install nightly
 ```
 
 List components in nightly channel:
+
 ```shell script
 rustup component list --toolchain nightly
 ```
 
 ## Update toolchains
 
 Run the following command to update the toolchains for all channel:
+
 ```shell script
 rustup update
 ```
 
 # Plugins for cargo
 
 To install:
+
 ```shell script
 cargo install <crate name>
 ```
 
 To update:
+
 ```shell script
 cargo install -f <crate name>
 ```
@@ -249,6 +257,7 @@ cargo build --vendored-openssl
 ## Development Libraries
 
 For *g3proxy*:
+
 ```text
 openssl >= 1.1.1
 c-ares >= 1.13.0
@@ -259,33 +268,38 @@ python3 >= 3.7
 ## Development Tools
 
 The tools for C development should be installed, including but not limited to:
+
 ```text
 gcc
 pkg-config
 ```
 
 If the c-ares version in the OS repo is too old, the following tools is also required:
+
 ```text
 cmake
 ```
 
 ## Rpc Code Generator
 
 We use capnproto rpc to communicate with the running daemon process:
+
 ```text
 capnproto
 ```
 
 ## Testing Tools
 
 The following tools are needed to run testing scripts:
+
 ```text
 curl
 ```
 
 ## Scripting Tools
 
 The following tools are used in scripts under directory *scripts/*:
+
 ```text
 git
 jq
@@ -296,6 +310,7 @@ xz
 ## Scripting Libraries
 
 We use python3 for more complicated scripts, the following packages are needed:
+
 ```text
 toml
 requests
@@ -306,13 +321,15 @@ dnspython
 
 ## Document Tools
 
-We use [sphinx](https://www.sphinx-doc.org/en/master/) to generate docs, with theme [sphinx-rtd-theme](https://pypi.org/project/sphinx-rtd-theme/).
+We use [sphinx](https://www.sphinx-doc.org/en/master/) to generate docs, with
+theme [sphinx-rtd-theme](https://pypi.org/project/sphinx-rtd-theme/).
 
 ## Packaging Tools
 
 ### deb
 
 For all *Debian* based distributions:
+
 ```text
 lsb-release
 dpkg-dev
@@ -322,6 +339,7 @@ debhelper
 ### rpm
 
 For all *rhel* based distributions:
+
 ```text
 rpmdevtools
 rpm-build