You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@submarine.apache.org by GitBox <gi...@apache.org> on 2020/11/20 09:08:15 UTC
[GitHub] [submarine] ByronHsu opened a new pull request #456: SUBMARINE-680. improve documentation
ByronHsu opened a new pull request #456:
URL: https://github.com/apache/submarine/pull/456
### What is this PR for?
A few sentences describing the overall goals of the pull request's commits.
First time? Check out the contributing guide - https://submarine.apache.org/contribution/contributions.html
I do the following revision on documentation.
1. Update some commands from 0.4.0 to 0.5.0.
2. Replace "mvn clean install package" with "mvn clean package" because "install" will be called automatically before "package". There is no need to specify it.
3. Remove vue.js part
4. Clarify database documentation
5. Add QuickDevTips.md, recording some useful tips for developers.
### What type of PR is it?
[Improvement]
### Todos
* [ ] - Task
### What is the Jira issue?
[SUBMARINE-680. Improve Documentation](https://issues.apache.org/jira/projects/SUBMARINE/issues/SUBMARINE-680?filter=allopenissues)
### How should this be tested?
### Screenshots (if appropriate)
### Questions:
* Does the licenses files need update? No
* Is there breaking changes for older versions? No
* Does this needs documentation? No
----------------------------------------------------------------
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
[GitHub] [submarine] ByronHsu closed pull request #456: SUBMARINE-682. Improve documentation generally
Posted by GitBox <gi...@apache.org>.
ByronHsu closed pull request #456:
URL: https://github.com/apache/submarine/pull/456
----------------------------------------------------------------
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
[GitHub] [submarine] ByronHsu commented on pull request #456: SUBMARINE-680. Improve documentation
Posted by GitBox <gi...@apache.org>.
ByronHsu commented on pull request #456:
URL: https://github.com/apache/submarine/pull/456#issuecomment-731049490
@pingsutw @wangdatan Can you help me review the revision? Thanks.
----------------------------------------------------------------
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
[GitHub] [submarine] ByronHsu commented on pull request #456: SUBMARINE-680. Improve documentation
Posted by GitBox <gi...@apache.org>.
ByronHsu commented on pull request #456:
URL: https://github.com/apache/submarine/pull/456#issuecomment-731042455
@pingsutw @tangzhankun Can you help check this PR? Thanks!
----------------------------------------------------------------
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
[GitHub] [submarine] ByronHsu removed a comment on pull request #456: SUBMARINE-680. Improve documentation
Posted by GitBox <gi...@apache.org>.
ByronHsu removed a comment on pull request #456:
URL: https://github.com/apache/submarine/pull/456#issuecomment-731042455
@pingsutw @tangzhankun Can you help check this PR? Thanks!
----------------------------------------------------------------
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
[GitHub] [submarine] pingsutw commented on a change in pull request #456: SUBMARINE-680. Improve documentation
Posted by 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