Added a link to developer guide from the home page of documentation

Signed-off-by: Lintong Jiang <lintongj@vmware.com>
vmware-tanzu · Sep 21, 2021 · ed4e127 · ed4e127
1 parent c220c92
commit ed4e127
Show file tree

Hide file tree

Showing 2 changed files with 17 additions and 3 deletions.
diff --git a/BUILDING.md b/BUILDING.md
@@ -1,8 +1,11 @@
+# Developer Guide
 
-## Building the plugin
+## Prerequisites
+
+- Download VDDK 7.0.2 libraries from [here](https://code.vmware.com/web/sdk/7.0/vddk) to
+`<local path to velero-plugin-for-vsphere project>/.libs` and untar it.
 
-The Velero Plugin for vSphere is implemented 
-The Velero Plugin for vSphere relies on astrolabe and gvddk.  Before building the plugin, 
+## Building the plugin
 
 To build the plugin, run
 
@@ -29,3 +32,10 @@ or, just push it by running
 $ make push REGISTRY=<your-repo> VERSION=<your-tag>
 ```
 
+## Testing the plugin
+
+To unit test the plugin, run
+
+```bash
+make test
+```
diff --git a/README.md b/README.md
@@ -58,6 +58,10 @@ Known issues are documented [here](docs/known_issues.md).
 
 If you encounter issues, review the [troubleshooting](docs/troubleshooting.md) docs or [file an issue](https://github.com/vmware-tanzu/velero-plugin-for-vsphere/issues).
 
+## Developer Guide
+
+Developer Guide is available at [here](BUILDING.md).
+
 ## Previous release
 
 For 1.0.2 release, see documenation [here](https://github.com/vmware-tanzu/velero-plugin-for-vsphere/tree/v1.0.2).