Update quickstart in the doc (#174)

vllm-project · Sep 13, 2024 · 1c3a7b0 · 1c3a7b0
1 parent 76cd6bb
commit 1c3a7b0
Show file tree

Hide file tree

Showing 2 changed files with 28 additions and 5 deletions.
diff --git a/README.md b/README.md
@@ -25,14 +25,13 @@ kubectl create -k config/dependency
 kubectl apply -k config/default
 ```
 
+Install stable distribution
 ```shell
-# Note: this command will be available after the repo going public
-
 # Install component dependencies
-kubectl create -k "github.com/aibrix/aibrix/config/dependency"
+kubectl create -k "github.com/aibrix/aibrix/config/dependency?ref=v0.1.0-rc.1"
 
 # Install aibrix components
-kubectl apply -k "github.com/aibrix/aibrix/config/default"
+kubectl apply -k "github.com/aibrix/aibrix/config/default?ref=v0.1.0-rc.1"
 ```
 
 ## Documentation

diff --git a/docs/source/getting_started/quickstart.rst b/docs/source/getting_started/quickstart.rst
@@ -4,4 +4,28 @@
 Quickstart
 ==========
 
-This section contains how to do a quickstart.
+
+To get started with AIBrix, clone `aibrix/aibrix` repository, and install the manifests.
+.. note::
+    This is the latest version which is not very stable, take your risk.
+
+.. code:: bash
+    # Local Testing
+    git clone https://github.com/aibrix/aibrix.git
+    cd aibrix
+
+    # Install component dependencies
+    kubectl create -k config/dependency
+
+    # Install aibrix components
+    kubectl apply -k config/default
+
+
+Install stable distribution.
+
+.. code:: bash
+    # Install component dependencies
+    kubectl create -k "github.com/aibrix/aibrix/config/dependency?ref=v0.1.0-rc.1"
+
+    # Install aibrix components
+    kubectl apply -k "github.com/aibrix/aibrix/config/default?ref=v0.1.0-rc.1"