You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@submarine.apache.org by pi...@apache.org on 2022/02/22 03:10:13 UTC
[submarine] branch master updated: SUBMARINE-1197. Update developer docs
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 740c39c SUBMARINE-1197. Update developer docs
740c39c is described below
commit 740c39c2eb8097f5543bed67390c1e2ef3877b8d
Author: Kevin Su <pi...@apache.org>
AuthorDate: Mon Feb 21 03:38:39 2022 +0800
SUBMARINE-1197. Update developer docs
Signed-off-by: Kevin Su <pingsutwapache.org>
### 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 duplicate content
### What type of PR is it?
[Improvement]
### Todos
* [ ] - Task
### 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`
-->
### 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.
-->
### Screenshots (if appropriate)
### Questions:
* Do the license files need updating? Yes/No
* Are there breaking changes for older versions? Yes/No
* Does this need new documentation? Yes/No
Author: Kevin Su <pi...@apache.org>
Signed-off-by: Kevin <pi...@apache.org>
Closes #884 from pingsutw/SUBMARINE-1197 and squashes the following commits:
d7c01280 [Kevin Su] SUBMARINE-1197. Update developer docs
---
website/docs/devDocs/BuildFromCode.md | 40 +-----------------------------
website/docs/devDocs/Development.md | 12 ++++-----
website/docs/devDocs/HowToVerify.md | 1 -
website/docs/devDocs/IntegrationTestE2E.md | 8 +++---
4 files changed, 11 insertions(+), 50 deletions(-)
diff --git a/website/docs/devDocs/BuildFromCode.md b/website/docs/devDocs/BuildFromCode.md
index 870fc61..eabeb86 100644
--- a/website/docs/devDocs/BuildFromCode.md
+++ b/website/docs/devDocs/BuildFromCode.md
@@ -47,50 +47,12 @@ Build submarine database image:
./dev-support/docker-images/database/build.sh
```
-### Building source code / binary distribution
-
-+ Checking releases for licenses
+### Checking releases for licenses
```
mvn clean org.apache.rat:apache-rat-plugin:check
```
-+ Create binary distribution with default hadoop version
-
-```
-mvn clean package -DskipTests
-```
-
-+ Create binary distribution with hadoop-2.9.x version
-
-```
-mvn clean package -DskipTests -Phadoop-2.9
-```
-
-+ Create binary distribution with hadoop-2.10.x version
-
-```
-mvn clean package -DskipTests -Phadoop-2.10
-```
-
-+ Create binary distribution with hadoop-3.1.x version
-
-```
-mvn clean package -DskipTests -Phadoop-3.1
-```
-
-+ Create binary distribution with hadoop-3.2.x version
-
-```
-mvn clean package -DskipTests -Phadoop-3.2
-```
-
-+ Create source code distribution
-
-```
-mvn clean package -DskipTests -Psrc
-```
-
### Building source code / binary distribution with Maven Wrapper
+ Maven Wrapper (Optional): Maven Wrapper can help you avoid dependencies problem about Maven version.
```
diff --git a/website/docs/devDocs/Development.md b/website/docs/devDocs/Development.md
index 6f8a83f..51edd56 100644
--- a/website/docs/devDocs/Development.md
+++ b/website/docs/devDocs/Development.md
@@ -24,7 +24,7 @@ The document [Submarine Local Deployment](../gettingStarted/localDeployment.md)
kubectl get pods -n ${your_namespace}
```
-A brief introduction about these components:
+A brief introduction about these components:
1. **tf-operator**: Enable users to run TensorFlow jobs distributedly
2. **pytorch-operator**: Enable users to run PyTorch jobs distributedly
@@ -52,13 +52,13 @@ A brief introduction about these components:
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. 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
+ - 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
@@ -123,7 +123,7 @@ Checkstyle plugin may help to detect violations directly from the IDE.
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.
-4. Frontend E2E test: [IntegrationTestE2E.md](./IntegrationTestE2E.md)
+4. Frontend E2E test: [IntegrationTestE2E.md](./IntegrationTestE2E.md)
## Develop database
@@ -159,7 +159,7 @@ To update the website, click “Edit this page” on the website.
### Add a new page
-If you want to add a new page to the website, make sure to add the file path to [sidebars.js](https://github.com/apache/submarine/blob/master/website/sidebars.js).
+If you want to add a new page to the website, make sure to add the file path to [sidebars.js](https://github.com/apache/submarine/blob/master/website/sidebars.js).
### Installation
We use the yarn package manager to install all dependencies for the website
diff --git a/website/docs/devDocs/HowToVerify.md b/website/docs/devDocs/HowToVerify.md
index 2883692..5e9c479 100644
--- a/website/docs/devDocs/HowToVerify.md
+++ b/website/docs/devDocs/HowToVerify.md
@@ -159,4 +159,3 @@ Unzip `apache-submarine-client-${release_version}-src.tar.gz` and ` apache-subma
- Whether the deployment is successful.
- Deploy a test environment to verify whether production and consumption can run normally.
- Verify what you think might go wrong.
-- ....
diff --git a/website/docs/devDocs/IntegrationTestE2E.md b/website/docs/devDocs/IntegrationTestE2E.md
index 46317dd..69a8427 100644
--- a/website/docs/devDocs/IntegrationTestE2E.md
+++ b/website/docs/devDocs/IntegrationTestE2E.md
@@ -40,7 +40,7 @@ title: How to Run Frontend Integration Test
# at submarine-test/test_e2e/run_frontend_e2e.sh
...
# ======= Modifiable Variables ======= #
- # Note: URL must start with "http"
+ # Note: URL must start with "http"
# (Ref: https://www.selenium.dev/selenium/docs/api/java/org/openqa/selenium/WebDriver.html#get(java.lang.String))
WORKBENCH_PORT=8080 #<= modify this
URL="http://127.0.0.1" #<=modify this
@@ -48,7 +48,7 @@ title: How to Run Frontend Integration Test
...
```
-4. Run run_frontend_e2e.sh (Run a specific test case)
+4. Run `run_frontend_e2e.sh` (Run a specific test case)
This script will check whether the port can be accessed or not, and run the test case.
```bash
@@ -62,7 +62,7 @@ title: How to Run Frontend Integration Test
```bash
# Make sure the Submarine workbench is running on 127.0.0.1:8080
cd submarine/submarine-test/test-e2e
- # Method 1:
+ # Method 1:
mvn verify
# Method 2:
@@ -77,4 +77,4 @@ title: How to Run Frontend Integration Test
* **WARNING**
* You **MUST** read the [document](https://www.selenium.dev/documentation/en/webdriver/waits/) carefully, and understand the difference between **explicit wait**, **implicit wait**, and **fluent wait**.
* **Do not mix implicit and explicit waits.** Doing so can cause unpredictable wait times.
-* We define many useful functions in [AbstractSubmarineIT.java](https://github.com/apache/submarine/blob/master/submarine-test/test-e2e/src/test/java/org/apache/submarine/AbstractSubmarineIT.java).
\ No newline at end of file
+* We define many useful functions in [AbstractSubmarineIT.java](https://github.com/apache/submarine/blob/master/submarine-test/test-e2e/src/test/java/org/apache/submarine/AbstractSubmarineIT.java).
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@submarine.apache.org
For additional commands, e-mail: dev-help@submarine.apache.org