From bfe720bfecf3171c1447135e33f135dcef0b0857 Mon Sep 17 00:00:00 2001
From: "zhenshan.cao" <zhenshan.cao@zilliz.com>
Date: Fri, 15 Jan 2021 18:03:16 +0800
Subject: [PATCH] Update doc

Signed-off-by: zhenshan.cao <zhenshan.cao@zilliz.com>
---
 .devcontainer.json                            |  4 ++--
 .gitignore                                    |  4 ++--
 docs/developer_guides/chap03_index_service.md | 21 +++++++++++++++++--
 docs/developer_guides/chap09_data_service.md  |  2 +-
 .../{init_devcontainer.sh => devcontainer.sh} | 20 ++++++++++++------
 5 files changed, 38 insertions(+), 13 deletions(-)
 rename scripts/{init_devcontainer.sh => devcontainer.sh} (77%)

diff --git a/.devcontainer.json b/.devcontainer.json
index a7368ab60c..63ea71e1da 100644
--- a/.devcontainer.json
+++ b/.devcontainer.json
@@ -1,8 +1,8 @@
 {
     "name": "Milvus Distributed Dev Container Definition",
-    "dockerComposeFile": ["./docker-compose-vscode.yml"],
+    "dockerComposeFile": ["./docker-compose-devcontainer.yml"],
     "service": "ubuntu",
-    "initializeCommand": "scripts/init_devcontainer.sh && docker-compose -f docker-compose-vscode.yml down || true",
+    "initializeCommand": "scripts/devcontainer.sh && docker-compose -f docker-compose-devcontainer.yml down || true",
     "workspaceFolder": "/go/src/github.com/zilliztech/milvus-distributed",
     "shutdownAction": "stopCompose",
     "extensions": [
diff --git a/.gitignore b/.gitignore
index 075351ae09..e90b9805bb 100644
--- a/.gitignore
+++ b/.gitignore
@@ -11,8 +11,8 @@ pulsar/client-cpp/build/*
 
 # vscode generated files
 .vscode
-docker-compose-vscode.yml
-docker-compose-vscode.yml.tmp
+docker-compose-devcontainer.yml
+docker-compose-devcontainer.yml.tmp
 
 cmake-build-debug
 cmake-build-release
diff --git a/docs/developer_guides/chap03_index_service.md b/docs/developer_guides/chap03_index_service.md
index 934b3a1725..f114c9f05a 100644
--- a/docs/developer_guides/chap03_index_service.md
+++ b/docs/developer_guides/chap03_index_service.md
@@ -16,7 +16,9 @@ type IndexService interface {
   RegisterNode(req RegisterNodeRequest) (RegisterNodeResponse, error)
   BuildIndex(req BuildIndexRequest) (BuildIndexResponse, error)
 	GetIndexStates(req IndexStatesRequest) (IndexStatesResponse, error)
-	GetIndexFilePaths(req IndexFilePathRequest) (IndexFilePathsResponse, error)
+  GetIndexFilePaths(req IndexFilePathRequest) (IndexFilePathsResponse, error)
+  NotifyTaskState(TaskStateNotification) error
+
 }
 ```
 
@@ -50,6 +52,21 @@ type BuildIndexResponse struct {
 }
 ```
 
+
+```go
+type BuildIndexCmd struct {
+  IndexID UniqueID
+  Req BuildIndexRequest
+}
+
+type TaskStateNotification struct {
+  IndexID UniqueID
+  IndexState IndexState
+  IndexFilePaths []string
+  FailReason  string
+}
+```
+
 * *GetIndexStates*
 
 ```go
@@ -95,7 +112,7 @@ type IndexNode interface {
 //  SetTimeTickChannel(channelName string) error
 //  SetStatsChannel(channelName string) error
   
-  BuildIndex(req BuildIndexRequest) (BuildIndexResponse, error)
+  BuildIndex(req BuildIndexCmd) error
 }
 ```
 
diff --git a/docs/developer_guides/chap09_data_service.md b/docs/developer_guides/chap09_data_service.md
index 0f8a357914..8c1db5a8e0 100644
--- a/docs/developer_guides/chap09_data_service.md
+++ b/docs/developer_guides/chap09_data_service.md
@@ -167,7 +167,7 @@ type InsertChannelRequest struct {
 
 ```go
 type InsertRequest struct {
-  RequestBase
+  MsgBase
   DbName string
   CollectionName string
   PartitionName string
diff --git a/scripts/init_devcontainer.sh b/scripts/devcontainer.sh
similarity index 77%
rename from scripts/init_devcontainer.sh
rename to scripts/devcontainer.sh
index 80321670b9..ab1a24dfd3 100755
--- a/scripts/init_devcontainer.sh
+++ b/scripts/devcontainer.sh
@@ -30,14 +30,22 @@ gid=$(id -g)
 [ "$uid" -lt 500 ] && uid=501
 [ "$gid" -lt 500 ] && gid=$uid
 
-awk 'c&&c--{sub(/^/,"#")} /# Build devcontainer/{c=5} 1' $ROOT_DIR/docker-compose.yml > $ROOT_DIR/docker-compose-vscode.yml.tmp
+awk 'c&&c--{sub(/^/,"#")} /# Build devcontainer/{c=5} 1' $ROOT_DIR/docker-compose.yml > $ROOT_DIR/docker-compose-devcontainer.yml.tmp
 
-awk 'c&&c--{sub(/^/,"#")} /# Command/{c=3} 1' $ROOT_DIR/docker-compose-vscode.yml.tmp > $ROOT_DIR/docker-compose-vscode.yml
+awk 'c&&c--{sub(/^/,"#")} /# Command/{c=3} 1' $ROOT_DIR/docker-compose-devcontainer.yml.tmp > $ROOT_DIR/docker-compose-devcontainer.yml
 
-rm $ROOT_DIR/docker-compose-vscode.yml.tmp
+rm $ROOT_DIR/docker-compose-devcontainer.yml.tmp
 
 if [ "${machine}" == "Mac" ];then
-    sed -i '' "s/# user: {{ CURRENT_ID }}/user: \"$uid:$gid\"/g" $ROOT_DIR/docker-compose-vscode.yml
+    sed -i '' "s/# user: {{ CURRENT_ID }}/user: \"$uid:$gid\"/g" $ROOT_DIR/docker-compose-devcontainer.yml
 else
-    sed -i "s/# user: {{ CURRENT_ID }}/user: \"$uid:$gid\"/g" $ROOT_DIR/docker-compose-vscode.yml
-fi
\ No newline at end of file
+    sed -i "s/# user: {{ CURRENT_ID }}/user: \"$uid:$gid\"/g" $ROOT_DIR/docker-compose-devcontainer.yml
+fi
+
+if [ "${1-}" = "up" ]; then
+    docker-compose -f $ROOT_DIR/docker-compose-devcontainer.yml up -d
+fi
+
+if [ "${1-}" = "down" ]; then
+    docker-compose -f $ROOT_DIR/docker-compose-devcontainer.yml down
+fi