This is an automated email from the ASF dual-hosted git repository.
pingsutw pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/submarine.git
The following commit(s) were added to refs/heads/master by this push:
new 40e613b SUBMARINE-751. Upload NTU workshop video
40e613b is described below
commit 40e613b427f46f6c8bde23cb54ae2493aeafe03d
Author: featherchen <[email protected]>
AuthorDate: Tue Mar 9 10:18:45 2021 +0800
SUBMARINE-751. Upload NTU workshop video
### What is this PR for?
Upload NTU workshop video
### What type of PR is it?
[Documentation]
### Todos
### What is the Jira issue?
https://issues.apache.org/jira/browse/SUBMARINE-751
### 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
Author: featherchen <[email protected]>
Author: Kevin Su <[email protected]>
Author: jeff-901 <[email protected]>
Signed-off-by: Kevin <[email protected]>
Closes #526 from featherchen/SUBMARINE-751 and squashes the following
commits:
3ae9d758 [Kevin Su] Update website/docs/devDocs/Development.md
a785b1eb [featherchen] SUBMARINE-751. Fixed typo and delete wrong commit
e63d773d [jeff-901] SUBMARINE-750. Replace port 8080 with port 32080 in API
example
4b7405e8 [featherchen] SUBMARINE-751. Add youtube link
2d7b85f3 [featherchen] SUBMARINE-751. Add youtube link
---
website/docs/devDocs/Development.md | 94 +++++++++++++++++++------------------
1 file changed, 49 insertions(+), 45 deletions(-)
diff --git a/website/docs/devDocs/Development.md
b/website/docs/devDocs/Development.md
index 7ba21d7..d849c53 100644
--- a/website/docs/devDocs/Development.md
+++ b/website/docs/devDocs/Development.md
@@ -35,6 +35,10 @@ The purpose of the components are as the following:
In this document, we only focus on the last two components. You can learn how
to develop server, database, and workbench here.
+## Video
+
+From [This Video](https://youtu.be/32Na2k6Alv4), you will know how to deal
with the configuration of Submarine and be able to contribute to it via Github.
+
## Develop server
### Prerequisites
@@ -49,96 +53,96 @@ Checkstyle plugin may help to detect violations directly
from the IDE.
1. Install Checkstyle+IDEA plugin from Preference -> Plugins
2. Open Preference -> Tools -> Checkstyle ->
- 1. Set Checkstyle version:
- - Checkstyle version: 8.0
- 2. Add (+) a new Configuration File
- - Description: Submarine
- - Use a local checkstyle
${SUBMARINE_HOME}/dev-support/maven-config/checkstyle.xml
+ 1. Set Checkstyle version:
+ - Checkstyle version: 8.0
+ 2. Add (+) a new Configuration File
+ - Description: Submarine
+ - Use a local checkstyle
${SUBMARINE_HOME}/dev-support/maven-config/checkstyle.xml
3. Open the Checkstyle Tool Window, select the Submarine rule and execute the
check
### Testing
- Unit Test
- For each class, there is a corresponding testClass. For example,
`SubmarineServerTest` is used for testing `SubmarineServer`. Whenever you add a
funtion in classes, you must write a unit test to test it.
+ For each class, there is a corresponding testClass. For example,
`SubmarineServerTest` is used for testing `SubmarineServer`. Whenever you add a
funtion in classes, you must write a unit test to test it.
- Integration Test
- See [IntegrationTest.md](./IntegrationTest.md)
+ See [IntegrationTest.md](./IntegrationTest.md)
### Build from source
- Before building
- 1. We assume the developer use **minikube** as a local kubernetes cluster.
- 2. Make sure you have **installed the submarine helm-chart** in the
cluster.
+ 1. We assume the developer use **minikube** as a local kubernetes cluster.
+ 2. Make sure you have **installed the submarine helm-chart** in the cluster.
1. Package the Submarine server into a new jar file
- ```bash
- mvn package -DskipTests
- ```
+ ```bash
+ mvn package -DskipTests
+ ```
2. Build the new server docker image in minikube
- ```bash
- # switch to minikube docker daemon to build image directly in minikube
- eval $(minikube docker-env)
+ ```bash
+ # switch to minikube docker daemon to build image directly in minikube
+ eval $(minikube docker-env)
- # run docker build
- ./dev-support/docker-images/submarine/build.sh
+ # run docker build
+ ./dev-support/docker-images/submarine/build.sh
- # exit minikube docker daemon
- eval $(minikube docker-env -u)
- ```
+ # exit minikube docker daemon
+ eval $(minikube docker-env -u)
+ ```
3. Update server pod
- ```bash
- helm upgrade --set submarine.server.dev=true submarine
./helm-charts/submarine
- ```
+ ```bash
+ helm upgrade --set submarine.server.dev=true submarine
./helm-charts/submarine
+ ```
- Set `submarine.server.dev` to `true`, enabling the server pod to be
launched with the new docker image.
+ Set `submarine.server.dev` to `true`, enabling the server pod to be
launched with the new docker image.
## Develop workbench
1. Deploy the Submarine
- Follow [Getting Started/Submarine Local
Deployment](../gettingStarted/localDeployment.md), and make sure you can
connect to `http://localhost:32080` in the browser.
+ Follow [Getting Started/Submarine Local
Deployment](../gettingStarted/localDeployment.md), and make sure you can
connect to `http://localhost:32080` in the browser.
2. Install the dependencies
- ```bash
- cd submarine-workbench/workbench-web
- npm install
- ```
+ ```bash
+ cd submarine-workbench/workbench-web
+ npm install
+ ```
3. Run the workbench based on proxy server
- ```bash
- npm run start
- ```
+ ```bash
+ npm run start
+ ```
- 1. The request sent to `http://localhost:4200` will be redirected to
`http://localhost:32080`.
- 2. Open `http://localhost:4200` in browser to see the real-time change of
workbench.
+ 1. The request sent to `http://localhost:4200` will be redirected to
`http://localhost:32080`.
+ 2. Open `http://localhost:4200` in browser to see the real-time change of
workbench.
## Develop database
1. Build the docker image
- ```bash
- # switch to minikube docker daemon to build image directly in minikube
- eval $(minikube docker-env)
+ ```bash
+ # switch to minikube docker daemon to build image directly in minikube
+ eval $(minikube docker-env)
- # run docker build
- ./dev-support/docker-images/database/build.sh
+ # run docker build
+ ./dev-support/docker-images/database/build.sh
- # exit minikube docker daemon
- eval $(minikube docker-env -u)
- ```
+ # exit minikube docker daemon
+ eval $(minikube docker-env -u)
+ ```
2. Deploy new pods in the cluster
- ```bash
- helm upgrade --set submarine.database.dev=true submarine
./helm-charts/submarine
- ```
\ No newline at end of file
+ ```bash
+ helm upgrade --set submarine.database.dev=true submarine
./helm-charts/submarine
+ ```
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
