From e74fa32f666e075b41f2d04b009b0977f6a45d6d Mon Sep 17 00:00:00 2001 From: Windfarer Date: Wed, 16 Sep 2020 12:04:07 +0800 Subject: [PATCH] fix doc --- README.md | 8 +++--- docs/blademaster-quickstart.md | 52 +--------------------------------- docs/cache-mc.md | 52 +--------------------------------- docs/cache-redis.md | 52 +--------------------------------- docs/database-mysql-orm.md | 52 +--------------------------------- docs/database-mysql.md | 52 +--------------------------------- docs/index.html | 2 ++ docs/ut-testcli.md | 3 -- docs/warden-mid.md | 5 +++- docs/warden-pb.md | 6 +++- docs/warden-resolver.md | 5 +++- docs/warden.md | 6 +++- 12 files changed, 29 insertions(+), 266 deletions(-) diff --git a/README.md b/README.md index 51559e2bd..1c233b24d 100644 --- a/README.md +++ b/README.md @@ -20,7 +20,7 @@ Kratos是[bilibili](https://www.bilibili.com)开源的一套Go微服务框架， * GRPC Warden：基于官方gRPC开发，集成[discovery](https://github.com/bilibili/discovery)服务发现，并融合P2C负载均衡； * Cache：优雅的接口化设计，非常方便的缓存序列化，推荐结合代理模式[overlord](https://github.com/bilibili/overlord)； * Database：集成MySQL/HBase/TiDB，添加熔断保护和统计支持，可快速发现数据层压力； -* Config：方便易用的[paladin sdk](https://windfarer.github.io/kratos/#/config)，可配合远程配置中心，实现配置版本管理和更新； +* Config：方便易用的[paladin sdk](https://go-kratos.github.io/kratos/#/config)，可配合远程配置中心，实现配置版本管理和更新； * Log：类似[zap](https://github.com/uber-go/zap)的field实现高性能日志库，并结合log-agent实现远程日志管理； * Trace：基于opentracing，集成了全链路trace支持（gRPC/HTTP/MySQL/Redis/Memcached）； * Kratos Tool：工具链，可快速生成标准项目，或者通过Protobuf生成代码，非常便捷使用gRPC、HTTP、swagger文档； @@ -50,12 +50,12 @@ go build 打开浏览器访问：[http://localhost:8000/kratos-demo/start](http://localhost:8000/kratos-demo/start)，你会看到输出了`Golang 大法好 ！！！` -[快速开始](https://windfarer.github.io/kratos/#/quickstart) [kratos工具](https://windfarer.github.io/kratos/#/kratos-tool) +[快速开始](https://go-kratos.github.io/kratos/#/quickstart) [kratos工具](https://go-kratos.github.io/kratos/#/kratos-tool) ## Documentation -> [简体中文](https://windfarer.github.io/kratos) -> [FAQ](https://windfarer.github.io/kratos/#/FAQ) +> [简体中文](https://go-kratos.github.io/kratos) +> [FAQ](https://go-kratos.github.io/kratos/#/FAQ) ## License Kratos is under the MIT license. See the [LICENSE](./LICENSE) file for details. diff --git a/docs/blademaster-quickstart.md b/docs/blademaster-quickstart.md index 84d84a214..d49064b50 100644 --- a/docs/blademaster-quickstart.md +++ b/docs/blademaster-quickstart.md @@ -1,56 +1,6 @@ -# 准备工作 - -推荐使用[kratos工具](kratos-tool.md)快速生成项目，如我们生成一个叫`kratos-demo`的项目。目录结构如下： - -``` -├── CHANGELOG.md -├── OWNERS -├── README.md -├── api -│   ├── api.bm.go -│   ├── api.pb.go -│   ├── api.proto -│   └── client.go -├── cmd -│   ├── cmd -│   └── main.go -├── configs -│   ├── application.toml -│   ├── db.toml -│   ├── grpc.toml -│   ├── http.toml -│   ├── memcache.toml -│   └── redis.toml -├── go.mod -├── go.sum -├── internal -│   ├── dao -│   │   ├── dao.bts.go -│   │   ├── dao.go -│   │   ├── db.go -│   │   ├── mc.cache.go -│   │   ├── mc.go -│   │   └── redis.go -│   ├── di -│   │   ├── app.go -│   │   ├── wire.go -│   │   └── wire_gen.go -│   ├── model -│   │   └── model.go -│   ├── server -│   │   ├── grpc -│   │   │   └── server.go -│   │   └── http -│   │   └── server.go -│   └── service -│   └── service.go -└── test - └── docker-compose.yaml -``` - # 路由 -创建项目成功后，进入`internal/server/http`目录下，打开`http.go`文件，其中有默认生成的`blademaster`模板。其中： +进入`internal/server/http`目录下，打开`http.go`文件，其中有默认生成的`blademaster`模板。其中： ```go engine = bm.DefaultServer(hc.Server) diff --git a/docs/cache-mc.md b/docs/cache-mc.md index 20e1e5fd5..04f60f967 100644 --- a/docs/cache-mc.md +++ b/docs/cache-mc.md @@ -1,58 +1,8 @@ -# 准备工作 - -推荐使用[kratos工具](kratos-tool.md)快速生成项目，如我们生成一个叫`kratos-demo`的项目。目录结构如下： - -``` -├── CHANGELOG.md -├── OWNERS -├── README.md -├── api -│   ├── api.bm.go -│   ├── api.pb.go -│   ├── api.proto -│   └── client.go -├── cmd -│   ├── cmd -│   └── main.go -├── configs -│   ├── application.toml -│   ├── db.toml -│   ├── grpc.toml -│   ├── http.toml -│   ├── memcache.toml -│   └── redis.toml -├── go.mod -├── go.sum -├── internal -│   ├── dao -│   │   ├── dao.bts.go -│   │   ├── dao.go -│   │   ├── db.go -│   │   ├── mc.cache.go -│   │   ├── mc.go -│   │   └── redis.go -│   ├── di -│   │   ├── app.go -│   │   ├── wire.go -│   │   └── wire_gen.go -│   ├── model -│   │   └── model.go -│   ├── server -│   │   ├── grpc -│   │   │   └── server.go -│   │   └── http -│   │   └── server.go -│   └── service -│   └── service.go -└── test - └── docker-compose.yaml -``` - # 开始使用 ## 配置 -创建项目成功后，进入项目中的configs目录，打开memcache.toml，我们可以看到： +进入项目中的configs目录，打开memcache.toml，我们可以看到： ```toml [Client] diff --git a/docs/cache-redis.md b/docs/cache-redis.md index e1cf3b081..898e419df 100644 --- a/docs/cache-redis.md +++ b/docs/cache-redis.md @@ -1,58 +1,8 @@ -# 准备工作 - -推荐使用[kratos工具](kratos-tool.md)快速生成项目，如我们生成一个叫`kratos-demo`的项目。目录结构如下： - -``` -├── CHANGELOG.md -├── OWNERS -├── README.md -├── api -│   ├── api.bm.go -│   ├── api.pb.go -│   ├── api.proto -│   └── client.go -├── cmd -│   ├── cmd -│   └── main.go -├── configs -│   ├── application.toml -│   ├── db.toml -│   ├── grpc.toml -│   ├── http.toml -│   ├── memcache.toml -│   └── redis.toml -├── go.mod -├── go.sum -├── internal -│   ├── dao -│   │   ├── dao.bts.go -│   │   ├── dao.go -│   │   ├── db.go -│   │   ├── mc.cache.go -│   │   ├── mc.go -│   │   └── redis.go -│   ├── di -│   │   ├── app.go -│   │   ├── wire.go -│   │   └── wire_gen.go -│   ├── model -│   │   └── model.go -│   ├── server -│   │   ├── grpc -│   │   │   └── server.go -│   │   └── http -│   │   └── server.go -│   └── service -│   └── service.go -└── test - └── docker-compose.yaml -``` - # 开始使用 ## 配置 -创建项目成功后，进入项目中的configs目录，打开redis.toml，我们可以看到： +进入项目中的configs目录，打开redis.toml，我们可以看到： ```toml [Client] diff --git a/docs/database-mysql-orm.md b/docs/database-mysql-orm.md index 69b76e089..e29d5b1b5 100644 --- a/docs/database-mysql-orm.md +++ b/docs/database-mysql-orm.md @@ -1,58 +1,8 @@ -# 准备工作 - -推荐使用[kratos工具](kratos-tool.md)快速生成项目，如我们生成一个叫`kratos-demo`的项目。目录结构如下： - -``` -├── CHANGELOG.md -├── OWNERS -├── README.md -├── api -│   ├── api.bm.go -│   ├── api.pb.go -│   ├── api.proto -│   └── client.go -├── cmd -│   ├── cmd -│   └── main.go -├── configs -│   ├── application.toml -│   ├── db.toml -│   ├── grpc.toml -│   ├── http.toml -│   ├── memcache.toml -│   └── redis.toml -├── go.mod -├── go.sum -├── internal -│   ├── dao -│   │   ├── dao.bts.go -│   │   ├── dao.go -│   │   ├── db.go -│   │   ├── mc.cache.go -│   │   ├── mc.go -│   │   └── redis.go -│   ├── di -│   │   ├── app.go -│   │   ├── wire.go -│   │   └── wire_gen.go -│   ├── model -│   │   └── model.go -│   ├── server -│   │   ├── grpc -│   │   │   └── server.go -│   │   └── http -│   │   └── server.go -│   └── service -│   └── service.go -└── test - └── docker-compose.yaml -``` - # 开始使用 ## 配置 -创建项目成功后，进入项目中的configs目录，mysql.toml，我们可以看到： +进入项目中的configs目录，mysql.toml，我们可以看到： ```toml [demo] diff --git a/docs/database-mysql.md b/docs/database-mysql.md index e189c570f..b907c9d60 100644 --- a/docs/database-mysql.md +++ b/docs/database-mysql.md @@ -1,58 +1,8 @@ -# 准备工作 - -推荐使用[kratos工具](kratos-tool.md)快速生成项目，如我们生成一个叫`kratos-demo`的项目。目录结构如下： - -``` -├── CHANGELOG.md -├── OWNERS -├── README.md -├── api -│   ├── api.bm.go -│   ├── api.pb.go -│   ├── api.proto -│   └── client.go -├── cmd -│   ├── cmd -│   └── main.go -├── configs -│   ├── application.toml -│   ├── db.toml -│   ├── grpc.toml -│   ├── http.toml -│   ├── memcache.toml -│   └── redis.toml -├── go.mod -├── go.sum -├── internal -│   ├── dao -│   │   ├── dao.bts.go -│   │   ├── dao.go -│   │   ├── db.go -│   │   ├── mc.cache.go -│   │   ├── mc.go -│   │   └── redis.go -│   ├── di -│   │   ├── app.go -│   │   ├── wire.go -│   │   └── wire_gen.go -│   ├── model -│   │   └── model.go -│   ├── server -│   │   ├── grpc -│   │   │   └── server.go -│   │   └── http -│   │   └── server.go -│   └── service -│   └── service.go -└── test - └── docker-compose.yaml -``` - # 开始使用 ## 配置 -创建项目成功后，进入项目中的configs目录，mysql.toml，我们可以看到： +进入项目中的configs目录，mysql.toml，我们可以看到： ```toml [demo] diff --git a/docs/index.html b/docs/index.html index b757f801a..f99e1244f 100644 --- a/docs/index.html +++ b/docs/index.html @@ -13,6 +13,8 @@