[GitHub] [submarine] pingsutw commented on a change in pull request #456: SUBMARINE-680. Improve documentation

[GitBox <gi...@apache.org>]

pingsutw commented on a change in pull request #456:
URL: https://github.com/apache/submarine/pull/456#discussion_r528049875



##########
File path: docs/development/QuickDevTips.md
##########
@@ -0,0 +1,34 @@
+## 1. Introduction
+
+This document describes some useful tips that can accelerate your development efficiency.
+
+### Run server outside of k8s
+If you are working on submarine-server, you do not need to bundle submarine-server into docker-image, and restart the helm-chart every time.
+
+You can run each module individually and only need to re-package the submarine-server, getting rid of other unnecessary process.
+
+1. Run db docker
+
+```
+docker run -it -p 3306:3306 -d --name submarine-database -e MYSQL_ROOT_PASSWORD=password apache/submarine:database-0.5.0-SNAPSHOT
+```
+2. Run k8s
+
+```
+kubectl apply -f ./dev-support/k8s/tfjob/crd.yaml
+kubectl kustomize ./dev-support/k8s/tfjob/operator | kubectl apply -f -
+kubectl apply -f ./dev-support/k8s/pytorchjob/
+export KUBECONFIG=/home/<user_name>/.kube/config # (in ~/.bashrc) 

Review comment:
       These commands are used to install tf-operator and PyTorch-operator, we should add `kind start ....`   or `minikube start ....`. before it.




----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

For queries about this service, please contact Infrastructure at:
users@infra.apache.org