chore(docs): fix docs for docarray

jina-ai · Dec 12, 2021 · c4ae700 · c4ae700
1 parent b66306e
commit c4ae700
Show file tree

Hide file tree

Showing 2 changed files with 18 additions and 1 deletion.
diff --git a/docarray/proto/build-proto.sh b/docarray/proto/build-proto.sh
@@ -3,7 +3,7 @@ set -ex
 
 # Do NOT use this directly, use jinaai/protogen image
 #
-# current dir: jina root (the one with README.md)
+# current dir: docarray root (the one with README.md)
 # run the following in bash:
 # docker run -v $(pwd)/proto:/jina/proto jinaai/protogen
 

diff --git a/docs/proto/index.md b/docs/proto/index.md
@@ -1,2 +1,19 @@
+````{tip}
+To update `docarray` Protobuf:
+
+```bash
+cd docarrat
+docker run -v $(pwd)/proto:/jina/proto jinaai/protogen
+```
+
+
+To update `jina` Protobuf:
+
+```bash
+docker run -v $(pwd)/jina/:/jina/ -v $(pwd)/docarray/:/docarray/ jinaai/protogen
+```
+
+````
+
 ```{include} docs.md
 ```