add hacking template

2019-12-08 14:20:26 +01:00 · 2019-12-08 14:20:26 +01:00 · 8e159c8be1
parent 0283894ba2
commit 8e159c8be1
2 changed files with 17 additions and 0 deletions
--- a/ucloud/docs/source/hacking.rst
+++ b/ucloud/docs/source/hacking.rst
@ -0,0 +1,16 @@
+Hacking
+=======
+How to hack on the code.
+
+[ to be done by Balazs:
+
+* make nice
+* indent with shell script mode
+
+]
+
+* git clone the repo
+* cd to the repo
+* Setup your venv: python -m venv venv
+* Run ./bin/ucloud-run-reinstall - it should print you an error
+  message on how to use ucloud
--- a/ucloud/docs/source/index.rst
+++ b/ucloud/docs/source/index.rst
@ -16,6 +16,7 @@ Welcome to ucloud's documentation!
   admin-guide
   user-guide/how-to-create-an-os-image-for-ucloud
   troubleshooting
+   hacking


 Indices and tables