This is an automated email from the ASF dual-hosted git repository.
kaihsun 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 7b7a79c SUBMARINE-918. Update devDocs directory structure
7b7a79c is described below
commit 7b7a79c523e5d9734aa611841fc18e40c33c689a
Author: Kevin Su <[email protected]>
AuthorDate: Sat Jul 10 20:06:28 2021 +0800
SUBMARINE-918. Update devDocs directory structure
### 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
-->
Remove and update outdated content.
### What type of PR is it?
[Documentation]
### Todos
* [ ] - Add develop operator in Development Guide
* [ ] - Add develop submarine website in Development Guide
* [ ] - Update overview in Development Guide
* [ ] - Update e2e test in
https://submarine.apache.org/docs/devDocs/IntegrationTest
### What is the Jira issue?
<!-- * Open an issue on Jira
https://issues.apache.org/jira/browse/SUBMARINE/
* Put link here, and add [SUBMARINE-*Jira number*] in PR title, eg.
`SUBMARINE-23. PR title`
-->
https://issues.apache.org/jira/browse/SUBMARINE-918
### How should this be tested?
<!--
* First time? Setup Travis CI as described on
https://submarine.apache.org/contribution/contributions.html#continuous-integration
* Strongly recommended: add automated unit tests for any new or changed
behavior
* Outline any manual steps to test the PR here.
-->
Pass the CIs
### Screenshots (if appropriate)
### Questions:
* Do the license files need updating? No
* Are there breaking changes for older versions? No
* Does this need new documentation? No
Author: Kevin Su <[email protected]>
Signed-off-by: Kai-Hsun Chen <[email protected]>
Closes #660 from pingsutw/SUBMARINE-918 and squashes the following commits:
aea0b142 [Kevin Su] Update devDocs directory structure
---
website/docs/assets/Run-Debug-Configuration.png | Bin 252823 -> 0 bytes
website/docs/devDocs/BuildFromCode.md | 13 ++---
website/docs/devDocs/IntegrationTest.md | 4 +-
website/docs/devDocs/README.md | 72 ------------------------
4 files changed, 6 insertions(+), 83 deletions(-)
diff --git a/website/docs/assets/Run-Debug-Configuration.png
b/website/docs/assets/Run-Debug-Configuration.png
deleted file mode 100644
index 9bff9c2..0000000
Binary files a/website/docs/assets/Run-Debug-Configuration.png and /dev/null
differ
diff --git a/website/docs/devDocs/BuildFromCode.md
b/website/docs/devDocs/BuildFromCode.md
index ecb3018..870fc61 100644
--- a/website/docs/devDocs/BuildFromCode.md
+++ b/website/docs/devDocs/BuildFromCode.md
@@ -24,12 +24,12 @@ title: How to Build Submarine
## Quick Start
-### Build Your Custom Submarine Docker Images
+### Build Your Custom Submarine Docker Images
-Submarine provides default Docker image in the release artifacts, sometimes
you would like to do some modifications on the images. You can rebuild Docker
image after you make changes.
+Submarine provides default Docker image in the release artifacts, sometimes
you would like to do some modifications on the images. You can rebuild Docker
image after you make changes.
> Note that you need to make sure the images built above can be accessed in k8s
-> Usually this needs a rename and push to a proper Docker registry.
+> Usually this needs to rename and push to a proper Docker registry.
```bash
mvn clean package -DskipTests
@@ -100,11 +100,6 @@ mvn -N io.takari:maven:0.7.7:wrapper -Dmaven=3.6.1
# Check Maven Wrapper
./mvnw -version
-# Replace 'mvn' with 'mvnw'. Example:
+# Replace 'mvn' with 'mvnw'. Example:
./mvnw clean package -DskipTests
```
-
-## TonY code modification
-
-If it is needed to make modifications to TonY project, please make a PR
-to [Tony repository](https://github.com/linkedin/TonY).
\ No newline at end of file
diff --git a/website/docs/devDocs/IntegrationTest.md
b/website/docs/devDocs/IntegrationTest.md
index 8409dcd..21c2b8c 100644
--- a/website/docs/devDocs/IntegrationTest.md
+++ b/website/docs/devDocs/IntegrationTest.md
@@ -49,9 +49,9 @@ mvn -Phadoop-2.9 clean package install -DskipTests verify
-DskipRat -am -pl subm
+ Call `submarine-cloud/hack/deploy-submarine.sh` to deploy the submarine
system in the k8s cluster using the latest `submarine`, `database` and
`operator` docker images.
+ Call the test cases in `submarine-test/test-k8s/` for testing.
-### Run k8s test in travis
+### Run k8s test in Github Action
-Each time a code is submitted, travis is automatically triggered for testing.
+Each time a code is submitted, Github Action is automatically triggered for
testing.
## E2E test
diff --git a/website/docs/devDocs/README.md b/website/docs/devDocs/README.md
index ac5d883..83d5039 100644
--- a/website/docs/devDocs/README.md
+++ b/website/docs/devDocs/README.md
@@ -72,75 +72,3 @@ Provide end-to-end and k8s test for submarine.
submarine-installer, it is easy to install and deploy system services such as
`docker`, `nvidia-docker`, `nvidia driver`, `ETCD`, `Calico network` etc.
required by yarn-3.1+.
-
-## 3. Submarine Workbench Development Guide
-
-Submarine workbench consists of three modules: workbench-server, workbench-web
-and database.
-
-First, you need to clone the entire Submarine project:
-
-```
-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](https://github.com/apache/submarine/tree/master/dev-support/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
-workbench-web directory.
-
-```bash
-cd submarine-workbench/workbench-web
-yarn install
-```
-
-The node.js dependency library will be installed in the node_modules
directory. node_modules does not need to be uploaded to the git repository. We
have excluded it in the submarine/.gitignore file. You can clean this by
manually deleting the directory or executing mvn clean. table of Contents.
-
-- **Compiles and hot-reloads for development**
-
-```bash
-yarn run build
-```
-
-By executing the above command, `workbench-web` will publish the web page to
the `workbench-web/dist` directory. Later we will also add the feature of
`workbench-web` to a WAR package, which only requires a `workbench-web.war`
file. Package can release submarine workbench.
-
-- **Lints and fixes files**
-
-When you write the `Angular, 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 angular and js files to avoid some warnings during the yarn build.
-
-```
-yarn run lint
-```
-
-In fact, you must execute this command when you develop and submit any
workbench-web feature. Otherwise, chances are that you won't be able to check
the code specification we set up in Travis.
-
-## 3.3 Workbench-server
-
-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 `submarine-server-core`.
-
-
-
-So you can pass http://127.0.0.1:8080 debugging or running to
submarine-workbench.
-
-- **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.
-
-2. The `workbench-web/dist` used by `workbench-server` is used as the webapp
directory, which is configured via `workbench-site.xml`, but we do not
recommend you to modify it.
-
-3. The submarine-workbench, IP and 8080 ports that are accessible locally
through the port 8080 of 127.0.0.1 are configured via `workbench-site.xml`, but
we do not recommend you to modify it.
-
-4. When you modify the `angular` or `js` of workbench-web, you need to execute
the yarn run build command in the workbench-web directory, and let your
modified code update to the dist directory, so that you can see the effect of
your code modification in the workbench.
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
