This is an automated email from the ASF dual-hosted git repository. liuxun 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 402bc0a SUBMARINE-464. Renew the filepath and screenshot for the workbench doc 402bc0a is described below commit 402bc0a12e14bd13672083ea4947fe58daebfef6 Author: cchung100m <cchung1...@cs.ccu.edu.tw> AuthorDate: Thu Apr 9 09:52:59 2020 +0800 SUBMARINE-464. Renew the filepath and screenshot for the workbench doc ### What is this PR for? Documentation improvement. ### What type of PR is it? [Improvement | Documentation] ### What is the Jira issue? https://issues.apache.org/jira/browse/SUBMARINE-464 ### How should this be tested? https://travis-ci.com/github/cchung100m/submarine/builds/159393276 ### Questions: * Does the licenses files need update? No * Is there breaking changes for older versions? No * Does this needs documentation? No Author: cchung100m <cchung1...@cs.ccu.edu.tw> Closes #257 from cchung100m/SUBMARINE-464 and squashes the following commits: 68cbd55 [cchung100m] update the address of project 346b3d6 [cchung100m] update the address of project 1cb4257 [cchung100m] [WORKBENCH] Renew the use classpath of module 029b793 [cchung100m] [WORKBENCH] Renew the filepath and screenshot for the workbench doc --- docs/assets/Run-Debug-Configuration.png | Bin 250049 -> 252823 bytes docs/development/README.md | 54 ++++++++++++++++---------------- 2 files changed, 27 insertions(+), 27 deletions(-) diff --git a/docs/assets/Run-Debug-Configuration.png b/docs/assets/Run-Debug-Configuration.png index 9dc0f20..9bff9c2 100644 Binary files a/docs/assets/Run-Debug-Configuration.png and b/docs/assets/Run-Debug-Configuration.png differ diff --git a/docs/development/README.md b/docs/development/README.md index 1a0bdda..493989b 100644 --- a/docs/development/README.md +++ b/docs/development/README.md @@ -22,15 +22,15 @@ This document mainly describes the structure of each module of the Submarine pro ### 2.1. dev-support -+ **mini-submarine**: by using the docker image provided by Submarine, you can -experience all the functions of Submarine in a single docker environment, while -mini-submarine also provides developers with a development and testing -environment, Avoid the hassle of installing and deploying the runtime ++ **mini-submarine**: by using the docker image provided by Submarine, you can +experience all the functions of Submarine in a single docker environment, while +mini-submarine also provides developers with a development and testing +environment, Avoid the hassle of installing and deploying the runtime environment. -+ **submarine-installer**: submarine-installer is our submarine runtime -environment installation tool for yarn-3.1+ and above.By using ++ **submarine-installer**: submarine-installer is our submarine runtime +environment installation tool for yarn-3.1+ and above.By using submarine-installer, it is easy to install and deploy system services such as -`docker`, `nvidia-docker`, `nvidia driver`, `ETCD`, `Calico network` etc. +`docker`, `nvidia-docker`, `nvidia driver`, `ETCD`, `Calico network` etc. required by yarn-3.1+. ### 2.2. submarine-all @@ -50,49 +50,49 @@ Waiting for supplement Waiting for supplement ### 2.6. submarine-sdk -+ **pysubmarine**: By using Submarine's python sdk library, you can output ++ **pysubmarine**: By using Submarine's python sdk library, you can output metrics such as metrics when the algorithm is executed in your python program by importing pysubmarine during the development of the machine learning algorithm. ### 2.7. submarine-workbench -+ **workbench-server**: is a Jetty-based web server service. Workbench-server -provides RESTful interface and Websocket interface. The RESTful interface -provides workbench-web with management capabilities for databases such as ++ **workbench-server**: is a Jetty-based web server service. Workbench-server +provides RESTful interface and Websocket interface. The RESTful interface +provides workbench-web with management capabilities for databases such as project, department, user, and role. -+ **workbench-web**: is a web front-end service based on `VUE.js` framework. -With `workbench-web` users can manage Submarine project, department, user, role -through browser. You can also use the notebook to develop machine learning ++ **workbench-web**: is a web front-end service based on `VUE.js` framework. +With `workbench-web` users can manage Submarine project, department, user, role +through browser. You can also use the notebook to develop machine learning algorithms, model release and other lifecycle management. ## 3. Submarine Workbench Development Guide Submarine workbench consists of three modules: workbench-server, workbench-web -and database. +and database. -First, you need to clone the entire Submarine project: +First, you need to clone the entire Submarine project: ``` -git clone https://github.com/hadoopsubmarine/submarine.git +git clone https://github.com/apache/submarine.git ``` ## 3.1 Database -Submarine selects mysql as the workbench database, and stores the table -structure and information of all the data in workbench in mysql. Please browse -the project's [Submarine Database Guide](../database/) documentation and follow -the instructions to install a mysql database via docker in your development and +Submarine selects mysql as the workbench database, and stores the table +structure and information of all the data in workbench in mysql. Please browse +the project's [Submarine Database Guide](../database/) documentation and follow +the instructions to install a mysql database via docker in your development and test environment. ## 3.2 Workbench-web + **Install dependencies** -You only need to execute the following command when you run workbench-web for -the first time, so you can follow the depend. environment of node.js in the +You only need to execute the following command when you run workbench-web for +the first time, so you can follow the depend. environment of node.js in the workbench-web directory. ```bash -cd submarine/workbench-web +cd submarine-workbench/workbench-web yarn install ``` @@ -108,7 +108,7 @@ By executing the above command, `workbench-web` will publish the web page to the + **Lints and fixes files** -When you write the `vue, js` file in `workbench-web` through IDEA, because IDEA can't format these files well, you need to execute the following command to format the vue and js files to avoid some warnings during the yarn build. +When you write the `vue, js` file in `workbench-web` through IDEA, because IDEA can't format these files well, you need to execute the following command to format the vue and js files to avoid some warnings during the yarn build. ``` yarn run lint @@ -120,13 +120,13 @@ In fact, you must execute this command when you develop and submit any workbench Workbench-server has a built-in jetty server service, so you don't need to install any web container service. You can start submarine workbench by launching `workbench-server` directly in IDEA. -+ **Run / Debug** : In the IDEA, add a Run/Debug Configuration, `Main Class:` select `org.apache.submarine.server.SubmarineServer`, `Use classpath of module:` select `workbench-server`. ++ **Run / Debug** : In the IDEA, add a Run/Debug Configuration, `Main Class:` select `org.apache.submarine.server.SubmarineServer`, `Use classpath of module:` select `submarine-server-core`. ![img](../assets/Run-Debug-Configuration.png) So you can pass http://127.0.0.1:8080 debugging or running to submarine-workbench. -+ **It should be noted**: ++ **It should be noted**: 1. Because `workbench-web/dist` is the webapp default directory of the workbench-server Jetty Server, the workbench-server will automatically load the `workbench-web/dist` directory after startup. --------------------------------------------------------------------- To unsubscribe, e-mail: dev-unsubscr...@submarine.apache.org For additional commands, e-mail: dev-h...@submarine.apache.org