Merge pull request #53 from tidb-incubator/update-guide

update guide
tidb-incubator · May 11, 2021 · 2506020 · 2506020
2 parents d5da09d + b6f9845
commit 2506020
Show file tree

Hide file tree

Showing 5 changed files with 16 additions and 2 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -4,6 +4,10 @@ All notable changes to the "ticode" extension will be documented in this file.
 
 Check [Keep a Changelog](http://keepachangelog.com/) for recommendations on how to structure this file.
 
+### 0.3.3
+
+- Update guide
+
 ### 0.3.2
 
 - Support connect to database by MySQL client one-click - [#50](https://github.com/tidb-incubator/tide/pull/50)

diff --git a/doc/guide.md b/doc/guide.md
@@ -145,7 +145,17 @@ Click **Start playground by config**:
 
 ## 5. Use VM & Topo manager
 
-// TODO
+When you don't have enough physical machines to deploy a real TiDB cluster, you can use vagrant to create some virtual machines and deploy the cluster to them.
+
+This feature supports manage virtual machines (create/destroy/reload) by vagrant, and deploy a cluster to virtual machines or physical machines.
+
+<div>
+  <img src="./vm-vagrant.png" style="zoom:50%">
+</div>
+
+<div>
+  <img src="./vm-deploy-cluster.png" style="zoom:50%">
+</div>
 
 ## 6. Use clusters
 

diff --git a/doc/vm-deploy-cluster.png b/doc/vm-deploy-cluster.png
diff --git a/doc/vm-vagrant.png b/doc/vm-vagrant.png
diff --git a/package.json b/package.json
@@ -7,7 +7,7 @@
   },
   "description": "make developing TiDB a breeze",
   "icon": "media/logo.png",
-  "version": "0.3.2",
+  "version": "0.3.3",
   "engines": {
     "vscode": "^1.52.0"
   },