Update gsctl doc

alibaba · Jun 13, 2024 · 9cbbbc3 · 9cbbbc3
1 parent db9b9e4
commit 9cbbbc3
Show file tree

Hide file tree

Showing 3 changed files with 6 additions and 9 deletions.
diff --git a/Makefile b/Makefile
@@ -79,9 +79,7 @@ clean:
 
 gsctl:
 	cd $(CLIENT_DIR) && \
-	python3 setup_gsctl.py bdist_wheel && \
-	python3 -m pip install dist/gsctl*.whl --force-reinstall && \
-	rm -fr build
+	python3 ./setup_gsctl.py develop --user
 
 
 client: learning

diff --git a/docs/flex/coordinator.md b/docs/flex/coordinator.md
@@ -1,4 +1,4 @@
-# GraphScope Coordinator
+# Coordinator
 
 The GraphScope Coordinator serves as a centralized entry point for users, providing a RESTful API that follows the Swagger specification. It supports multiple language SDKs, including Python, and offers a unified interface. The main purpose of the Coordinator is to abstract and standardize the underlying engines and storage systems, shielding users from their complexities. This allows users to interact with the GraphScope platform through a simplified and consistent set of APIs, making it easier for users to understand and utilize the functionalities provided by GraphScope.
 

diff --git a/docs/utilities/gs.md b/docs/utilities/gs.md
@@ -1,23 +1,22 @@
 # Command-line Utility `gsctl`
 
-`gsctl` is a command-line utility for GraphScope. It is shipped with `graphscope-client` and provides a set of functionalities to make it easy to use GraphScope. These functionalities include building and testing binaries, managing sessions and resources, and more.
+`gsctl` is a command-line utility for GraphScope. It provides a set of functionalities to make it easy to use GraphScope. These functionalities include building and testing binaries, managing sessions and resources, and more.
 
 ## Install/Update `gsctl`
 
-Since it is shipped with python package `graphscope-client`, the `gsctl` command will be available in your terminal after installing GraphScope:
 ```bash
-$ pip3 install graphscope-client
+$ pip3 install gsctl
 ```
 
 In some cases, such as development on `gsctl`, you may want to build it from source.
 To do this, navigate to the directory where the source code is located and run the following command:
 
 ```bash
-$ cd REPO_HOME/python
+$ cd REPO_HOME
 # If you want to develop gsctl,
 # please note the entry point is located on:
 # /python/graphscope/gsctl/gsctl.py
-$ pip3 install --editable .
+$ make gsctl
 ```
 This will install `gsctl` in an editable mode, which means that any changes you make to the source code will be reflected in the installed version of `gsctl`.