浏览代码

perfect the bookstore and shorturl doc (#109)

* perfect the bookstore and shorturl doc

* 避免歧义
janetyu 4 年之前
父节点
当前提交
d4240cd4b0
共有 4 个文件被更改,包括 12 次插入4 次删除
  1. 3 1
      doc/bookstore-en.md
  2. 3 1
      doc/bookstore.md
  3. 3 1
      doc/shorturl-en.md
  4. 3 1
      doc/shorturl.md

+ 3 - 1
doc/bookstore-en.md

@@ -69,7 +69,7 @@ And now, let’s walk through the complete flow of quickly create a microservice
   GO111MODULE=on go get -u github.com/tal-tech/go-zero/tools/goctl
   GO111MODULE=on go get -u github.com/tal-tech/go-zero/tools/goctl
   ```
   ```
 
 
-* create the working dir bookstore
+* create the working dir `bookstore` and `bookstore/api`
 
 
 * in `bookstore` dir, execute `go mod init bookstore` to initialize `go.mod``
 * in `bookstore` dir, execute `go mod init bookstore` to initialize `go.mod``
 
 
@@ -191,6 +191,8 @@ And now, let’s walk through the complete flow of quickly create a microservice
 
 
 ## 6. Write code for add rpc service
 ## 6. Write code for add rpc service
 
 
+- under directory `bookstore` create dir `rpc`
+
 * under directory `rpc/add` create `add.proto` file
 * under directory `rpc/add` create `add.proto` file
 
 
   ```shell
   ```shell

+ 3 - 1
doc/bookstore.md

@@ -69,7 +69,7 @@
   GO111MODULE=on GOPROXY=https://goproxy.cn/,direct go get -u github.com/tal-tech/go-zero/tools/goctl
   GO111MODULE=on GOPROXY=https://goproxy.cn/,direct go get -u github.com/tal-tech/go-zero/tools/goctl
   ```
   ```
 
 
-* 创建工作目录`bookstore`
+* 创建工作目录 `bookstore` 和 `bookstore/api`
 
 
 * 在`bookstore`目录下执行`go mod init bookstore`初始化`go.mod`
 * 在`bookstore`目录下执行`go mod init bookstore`初始化`go.mod`
 
 
@@ -191,6 +191,8 @@
 
 
 ## 6. 编写add rpc服务
 ## 6. 编写add rpc服务
 
 
+- 在 `bookstore` 下创建 `rpc` 目录
+
 * 在`rpc/add`目录下编写`add.proto`文件
 * 在`rpc/add`目录下编写`add.proto`文件
 
 
   可以通过命令生成proto文件模板
   可以通过命令生成proto文件模板

+ 3 - 1
doc/shorturl-en.md

@@ -72,7 +72,7 @@ And now, let’s walk through the complete flow of quickly create a microservice
   GO111MODULE=on go get -u github.com/tal-tech/go-zero/tools/goctl
   GO111MODULE=on go get -u github.com/tal-tech/go-zero/tools/goctl
   ```
   ```
 
 
-* create the working dir `shorturl`
+* create the working dir `shorturl` and `shorturl/api`
 
 
 * in `shorturl` dir, execute `go mod init shorturl` to initialize `go.mod`
 * in `shorturl` dir, execute `go mod init shorturl` to initialize `go.mod`
 
 
@@ -195,6 +195,8 @@ And now, let’s walk through the complete flow of quickly create a microservice
 
 
 ## 6. Write code for transform rpc service
 ## 6. Write code for transform rpc service
 
 
+- under directory `shorturl` create dir `rpc`
+
 * under directory `rpc/transform` create `transform.proto` file
 * under directory `rpc/transform` create `transform.proto` file
 
 
   ```shell
   ```shell

+ 3 - 1
doc/shorturl.md

@@ -72,7 +72,7 @@
   GO111MODULE=on GOPROXY=https://goproxy.cn/,direct go get -u github.com/tal-tech/go-zero/tools/goctl
   GO111MODULE=on GOPROXY=https://goproxy.cn/,direct go get -u github.com/tal-tech/go-zero/tools/goctl
   ```
   ```
 
 
-* 创建工作目录`shorturl`
+* 创建工作目录 `shorturl` 和 `shorturl/api`
 
 
 * 在`shorturl`目录下执行`go mod init shorturl`初始化`go.mod`
 * 在`shorturl`目录下执行`go mod init shorturl`初始化`go.mod`
 
 
@@ -195,6 +195,8 @@
 
 
 ## 6. 编写transform rpc服务
 ## 6. 编写transform rpc服务
 
 
+- 在 `shorturl` 目录下创建 `rpc` 目录
+
 * 在`rpc/transform`目录下编写`transform.proto`文件
 * 在`rpc/transform`目录下编写`transform.proto`文件
 
 
   可以通过命令生成proto文件模板
   可以通过命令生成proto文件模板