You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@dolphinscheduler.apache.org by GitBox <gi...@apache.org> on 2021/08/04 11:18:54 UTC
[GitHub] [dolphinscheduler-website] QuakeWang opened a new pull request #416: [SOC] Translate the dev-run page
QuakeWang opened a new pull request #416:
URL: https://github.com/apache/dolphinscheduler-website/pull/416
Translate the [dev-run](https://dolphinscheduler.apache.org/zh-cn/docs/dev/user_doc/dev_run.html) page.
--
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.
To unsubscribe, e-mail: commits-unsubscribe@dolphinscheduler.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [dolphinscheduler-website] QuakeWang commented on pull request #416: [SOC] Translate the dev-run page
Posted by GitBox <gi...@apache.org>.
QuakeWang commented on pull request #416:
URL: https://github.com/apache/dolphinscheduler-website/pull/416#issuecomment-892576844
@ptyp PTAL
--
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.
To unsubscribe, e-mail: commits-unsubscribe@dolphinscheduler.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [dolphinscheduler-website] ptyp commented on a change in pull request #416: [SOC] Translate the dev-run page
Posted by GitBox <gi...@apache.org>.
ptyp commented on a change in pull request #416:
URL: https://github.com/apache/dolphinscheduler-website/pull/416#discussion_r684592399
##########
File path: docs/en-us/dev/user_doc/dev-run.md
##########
@@ -0,0 +1,135 @@
+## Development Environment Setup
+
+> Reference: [DolphinScheduler builds the development environment on Windows local.](https://dolphinscheduler.apache.org/zh-cn/blog/DS_run_in_windows.html)
+
+#### 1. Download source code
+
+GitHub ：https://github.com/apache/dolphinscheduler
+
+```shell
+mkdir dolphinscheduler
+cd dolphinscheduler
+git clone git@github.com:apache/dolphinscheduler.git
+```
+
+We use the dev branch here.
+
+#### 2. Windows install of zookeeper.
Review comment:
"The zookeeper installation for Windows"
##########
File path: docs/en-us/dev/user_doc/dev-run.md
##########
@@ -0,0 +1,135 @@
+## Development Environment Setup
+
+> Reference: [DolphinScheduler builds the development environment on Windows local.](https://dolphinscheduler.apache.org/zh-cn/blog/DS_run_in_windows.html)
+
+#### 1. Download source code
+
+GitHub ：https://github.com/apache/dolphinscheduler
+
+```shell
+mkdir dolphinscheduler
+cd dolphinscheduler
+git clone git@github.com:apache/dolphinscheduler.git
+```
+
+We use the dev branch here.
+
+#### 2. Windows install of zookeeper.
+
+i. Download [zookeeper](https://www.apache.org/dyn/closer.lua/zookeeper/zookeeper-3.6.3/apache-zookeeper-3.6.3-bin.tar.gz)
+
+ii. Unzip apache-zookeeper-3.6.3-bin.tar.gz
+
+iii. Create new zkData, zkLog folders in zk's directory.
+
+iv. Copy the zoo_sample.cfg file from the conf directory. Then rename it to zoo.cfg and change the configuration of the data and logs in it. For example:
+
+```
+dataDir=D:\\code\\apache-zookeeper-3.6.3-bin\\zkData
+dataLogDir=D:\\code\\apache-zookeeper-3.6.3-bin\\zkLog
+```
+
+v. Run zkServer.cmd in the bin, and then run zkCli.cmd to view the running status of zk. You can view the zk node information, which means the installation is successful.
+
+#### 3. Set up the back-end
+
+i. Create a new database locally for debugging. DolphinScheduler supports mysql and postgresql, here we use mysql for configuration and the database name could be : dolphinscheduler.
+
+ii. Import the code into IDEA, modify pom.xml in the root project, and change the scope of the mysql-connector-java dependency to compile.
+
+iii. Run `mvn -U install package -Prelease -Dmaven.test.skip=true `in terminal to install the required registered plugins.
+
+iv. Modify the datasource.properties of the dolphinscheduler-dao module:
+
+```properties
+# mysql
+spring.datasource.driver-class-name=com.mysql.jdbc.Driver
+spring.datasource.url=jdbc:mysql://localhost:3306/dolphinscheduler?useUnicode=true&characterEncoding=UTF-8
+spring.datasource.username=root
+spring.datasource.password=123456
+```
+
+v. Refresh the dao module and run the main method of org.apache.dolphinscheduler.dao.upgrade.shell.CreateDolphinScheduler to automatically insert the tables and data which are required by the project.
+
+vi. Modify the registry.properties of the dolphinscheduler-service module:
+
+```properties
+#registry.plugin.dir config the Registry Plugin dir.
+registry.plugin.dir=./dolphinscheduler-dist/target/dolphinscheduler-dist-1.3.6-SNAPSHOT/lib/plugin/registry/zookeeper
+
+registry.plugin.name=zookeeper
+registry.servers=127.0.0.1:2181
+```
+
+vii. Add console output to logback-worker.xml, logback-master.xml, and logback-api.xml.
+
+```xml
+<root level="INFO">
+ <appender-ref ref="STDOUT"/> <!-- 添加控制台输出 -->
+ <appender-ref ref="APILOGFILE"/>
+ <appender-ref ref="SKYWALKING-LOG"/>
+</root>
+```
+
+viii. Start MasterServer
+
+ Run the main method of org.apache.dolphinscheduler.server.master.MasterServer, you need to set the following VM options:
+
+```
+-Dlogging.config=classpath:logback-master.xml -Ddruid.mysql.usePingMethod=false
+```
+
+ix. Start WorkerServer
+
+run the main method of org.apache.dolphinscheduler.server.worker.WorkerServer, you need to set the following VM options:
+
+```
+-Dlogging.config=classpath:logback-worker.xml -Ddruid.mysql.usePingMethod=false
+```
+
+x. Start ApiApplicationServer
+
+run the main method of org.apache.dolphinscheduler.api.ApiApplicationServer, you need to set the following VM options:
Review comment:
It should be the capital R in the beginning.
", you need" => ". You need"
##########
File path: docs/en-us/dev/user_doc/dev-run.md
##########
@@ -0,0 +1,135 @@
+## Development Environment Setup
+
+> Reference: [DolphinScheduler builds the development environment on Windows local.](https://dolphinscheduler.apache.org/zh-cn/blog/DS_run_in_windows.html)
+
+#### 1. Download source code
+
+GitHub ：https://github.com/apache/dolphinscheduler
+
+```shell
+mkdir dolphinscheduler
+cd dolphinscheduler
+git clone git@github.com:apache/dolphinscheduler.git
+```
+
+We use the dev branch here.
+
+#### 2. Windows install of zookeeper.
+
+i. Download [zookeeper](https://www.apache.org/dyn/closer.lua/zookeeper/zookeeper-3.6.3/apache-zookeeper-3.6.3-bin.tar.gz)
+
+ii. Unzip apache-zookeeper-3.6.3-bin.tar.gz
+
+iii. Create new zkData, zkLog folders in zk's directory.
+
+iv. Copy the zoo_sample.cfg file from the conf directory. Then rename it to zoo.cfg and change the configuration of the data and logs in it. For example:
+
+```
+dataDir=D:\\code\\apache-zookeeper-3.6.3-bin\\zkData
+dataLogDir=D:\\code\\apache-zookeeper-3.6.3-bin\\zkLog
+```
+
+v. Run zkServer.cmd in the bin, and then run zkCli.cmd to view the running status of zk. You can view the zk node information, which means the installation is successful.
Review comment:
"If you can view ..., it means the ..."
##########
File path: docs/en-us/dev/user_doc/dev-run.md
##########
@@ -0,0 +1,135 @@
+## Development Environment Setup
+
+> Reference: [DolphinScheduler builds the development environment on Windows local.](https://dolphinscheduler.apache.org/zh-cn/blog/DS_run_in_windows.html)
+
+#### 1. Download source code
+
+GitHub ：https://github.com/apache/dolphinscheduler
+
+```shell
+mkdir dolphinscheduler
+cd dolphinscheduler
+git clone git@github.com:apache/dolphinscheduler.git
+```
+
+We use the dev branch here.
+
+#### 2. Windows install of zookeeper.
+
+i. Download [zookeeper](https://www.apache.org/dyn/closer.lua/zookeeper/zookeeper-3.6.3/apache-zookeeper-3.6.3-bin.tar.gz)
+
+ii. Unzip apache-zookeeper-3.6.3-bin.tar.gz
+
+iii. Create new zkData, zkLog folders in zk's directory.
+
+iv. Copy the zoo_sample.cfg file from the conf directory. Then rename it to zoo.cfg and change the configuration of the data and logs in it. For example:
+
+```
+dataDir=D:\\code\\apache-zookeeper-3.6.3-bin\\zkData
+dataLogDir=D:\\code\\apache-zookeeper-3.6.3-bin\\zkLog
+```
+
+v. Run zkServer.cmd in the bin, and then run zkCli.cmd to view the running status of zk. You can view the zk node information, which means the installation is successful.
+
+#### 3. Set up the back-end
+
+i. Create a new database locally for debugging. DolphinScheduler supports mysql and postgresql, here we use mysql for configuration and the database name could be : dolphinscheduler.
+
+ii. Import the code into IDEA, modify pom.xml in the root project, and change the scope of the mysql-connector-java dependency to compile.
+
+iii. Run `mvn -U install package -Prelease -Dmaven.test.skip=true `in terminal to install the required registered plugins.
+
+iv. Modify the datasource.properties of the dolphinscheduler-dao module:
+
+```properties
+# mysql
+spring.datasource.driver-class-name=com.mysql.jdbc.Driver
+spring.datasource.url=jdbc:mysql://localhost:3306/dolphinscheduler?useUnicode=true&characterEncoding=UTF-8
+spring.datasource.username=root
+spring.datasource.password=123456
+```
+
+v. Refresh the dao module and run the main method of org.apache.dolphinscheduler.dao.upgrade.shell.CreateDolphinScheduler to automatically insert the tables and data which are required by the project.
+
+vi. Modify the registry.properties of the dolphinscheduler-service module:
+
+```properties
+#registry.plugin.dir config the Registry Plugin dir.
+registry.plugin.dir=./dolphinscheduler-dist/target/dolphinscheduler-dist-1.3.6-SNAPSHOT/lib/plugin/registry/zookeeper
+
+registry.plugin.name=zookeeper
+registry.servers=127.0.0.1:2181
+```
+
+vii. Add console output to logback-worker.xml, logback-master.xml, and logback-api.xml.
+
+```xml
+<root level="INFO">
+ <appender-ref ref="STDOUT"/> <!-- 添加控制台输出 -->
+ <appender-ref ref="APILOGFILE"/>
+ <appender-ref ref="SKYWALKING-LOG"/>
+</root>
+```
+
+viii. Start MasterServer
Review comment:
"Start the MasterServer"
##########
File path: docs/en-us/dev/user_doc/dev-run.md
##########
@@ -0,0 +1,135 @@
+## Development Environment Setup
+
+> Reference: [DolphinScheduler builds the development environment on Windows local.](https://dolphinscheduler.apache.org/zh-cn/blog/DS_run_in_windows.html)
+
+#### 1. Download source code
+
+GitHub ：https://github.com/apache/dolphinscheduler
+
+```shell
+mkdir dolphinscheduler
+cd dolphinscheduler
+git clone git@github.com:apache/dolphinscheduler.git
+```
+
+We use the dev branch here.
+
+#### 2. Windows install of zookeeper.
+
+i. Download [zookeeper](https://www.apache.org/dyn/closer.lua/zookeeper/zookeeper-3.6.3/apache-zookeeper-3.6.3-bin.tar.gz)
+
+ii. Unzip apache-zookeeper-3.6.3-bin.tar.gz
+
+iii. Create new zkData, zkLog folders in zk's directory.
+
+iv. Copy the zoo_sample.cfg file from the conf directory. Then rename it to zoo.cfg and change the configuration of the data and logs in it. For example:
+
+```
+dataDir=D:\\code\\apache-zookeeper-3.6.3-bin\\zkData
+dataLogDir=D:\\code\\apache-zookeeper-3.6.3-bin\\zkLog
+```
+
+v. Run zkServer.cmd in the bin, and then run zkCli.cmd to view the running status of zk. You can view the zk node information, which means the installation is successful.
+
+#### 3. Set up the back-end
+
+i. Create a new database locally for debugging. DolphinScheduler supports mysql and postgresql, here we use mysql for configuration and the database name could be : dolphinscheduler.
+
+ii. Import the code into IDEA, modify pom.xml in the root project, and change the scope of the mysql-connector-java dependency to compile.
+
+iii. Run `mvn -U install package -Prelease -Dmaven.test.skip=true `in terminal to install the required registered plugins.
+
+iv. Modify the datasource.properties of the dolphinscheduler-dao module:
+
+```properties
+# mysql
+spring.datasource.driver-class-name=com.mysql.jdbc.Driver
+spring.datasource.url=jdbc:mysql://localhost:3306/dolphinscheduler?useUnicode=true&characterEncoding=UTF-8
+spring.datasource.username=root
+spring.datasource.password=123456
+```
+
+v. Refresh the dao module and run the main method of org.apache.dolphinscheduler.dao.upgrade.shell.CreateDolphinScheduler to automatically insert the tables and data which are required by the project.
+
+vi. Modify the registry.properties of the dolphinscheduler-service module:
+
+```properties
+#registry.plugin.dir config the Registry Plugin dir.
+registry.plugin.dir=./dolphinscheduler-dist/target/dolphinscheduler-dist-1.3.6-SNAPSHOT/lib/plugin/registry/zookeeper
+
+registry.plugin.name=zookeeper
+registry.servers=127.0.0.1:2181
+```
+
+vii. Add console output to logback-worker.xml, logback-master.xml, and logback-api.xml.
Review comment:
"Add the console output"
##########
File path: docs/en-us/dev/user_doc/dev-run.md
##########
@@ -0,0 +1,135 @@
+## Development Environment Setup
+
+> Reference: [DolphinScheduler builds the development environment on Windows local.](https://dolphinscheduler.apache.org/zh-cn/blog/DS_run_in_windows.html)
+
+#### 1. Download source code
+
+GitHub ：https://github.com/apache/dolphinscheduler
+
+```shell
+mkdir dolphinscheduler
+cd dolphinscheduler
+git clone git@github.com:apache/dolphinscheduler.git
+```
+
+We use the dev branch here.
+
+#### 2. Windows install of zookeeper.
+
+i. Download [zookeeper](https://www.apache.org/dyn/closer.lua/zookeeper/zookeeper-3.6.3/apache-zookeeper-3.6.3-bin.tar.gz)
+
+ii. Unzip apache-zookeeper-3.6.3-bin.tar.gz
+
+iii. Create new zkData, zkLog folders in zk's directory.
+
+iv. Copy the zoo_sample.cfg file from the conf directory. Then rename it to zoo.cfg and change the configuration of the data and logs in it. For example:
+
+```
+dataDir=D:\\code\\apache-zookeeper-3.6.3-bin\\zkData
+dataLogDir=D:\\code\\apache-zookeeper-3.6.3-bin\\zkLog
+```
+
+v. Run zkServer.cmd in the bin, and then run zkCli.cmd to view the running status of zk. You can view the zk node information, which means the installation is successful.
+
+#### 3. Set up the back-end
+
+i. Create a new database locally for debugging. DolphinScheduler supports mysql and postgresql, here we use mysql for configuration and the database name could be : dolphinscheduler.
+
+ii. Import the code into IDEA, modify pom.xml in the root project, and change the scope of the mysql-connector-java dependency to compile.
+
+iii. Run `mvn -U install package -Prelease -Dmaven.test.skip=true `in terminal to install the required registered plugins.
+
+iv. Modify the datasource.properties of the dolphinscheduler-dao module:
+
+```properties
+# mysql
+spring.datasource.driver-class-name=com.mysql.jdbc.Driver
+spring.datasource.url=jdbc:mysql://localhost:3306/dolphinscheduler?useUnicode=true&characterEncoding=UTF-8
+spring.datasource.username=root
+spring.datasource.password=123456
+```
+
+v. Refresh the dao module and run the main method of org.apache.dolphinscheduler.dao.upgrade.shell.CreateDolphinScheduler to automatically insert the tables and data which are required by the project.
+
+vi. Modify the registry.properties of the dolphinscheduler-service module:
+
+```properties
+#registry.plugin.dir config the Registry Plugin dir.
+registry.plugin.dir=./dolphinscheduler-dist/target/dolphinscheduler-dist-1.3.6-SNAPSHOT/lib/plugin/registry/zookeeper
+
+registry.plugin.name=zookeeper
+registry.servers=127.0.0.1:2181
+```
+
+vii. Add console output to logback-worker.xml, logback-master.xml, and logback-api.xml.
+
+```xml
+<root level="INFO">
+ <appender-ref ref="STDOUT"/> <!-- 添加控制台输出 -->
Review comment:
The Chinese sentence (添加控制台输出) is forgotten to be translated.
##########
File path: docs/en-us/dev/user_doc/dev-run.md
##########
@@ -0,0 +1,135 @@
+## Development Environment Setup
+
+> Reference: [DolphinScheduler builds the development environment on Windows local.](https://dolphinscheduler.apache.org/zh-cn/blog/DS_run_in_windows.html)
+
+#### 1. Download source code
Review comment:
"Download the source code"
##########
File path: docs/en-us/dev/user_doc/dev-run.md
##########
@@ -0,0 +1,135 @@
+## Development Environment Setup
+
+> Reference: [DolphinScheduler builds the development environment on Windows local.](https://dolphinscheduler.apache.org/zh-cn/blog/DS_run_in_windows.html)
+
+#### 1. Download source code
+
+GitHub ：https://github.com/apache/dolphinscheduler
+
+```shell
+mkdir dolphinscheduler
+cd dolphinscheduler
+git clone git@github.com:apache/dolphinscheduler.git
+```
+
+We use the dev branch here.
+
+#### 2. Windows install of zookeeper.
+
+i. Download [zookeeper](https://www.apache.org/dyn/closer.lua/zookeeper/zookeeper-3.6.3/apache-zookeeper-3.6.3-bin.tar.gz)
+
+ii. Unzip apache-zookeeper-3.6.3-bin.tar.gz
+
+iii. Create new zkData, zkLog folders in zk's directory.
+
+iv. Copy the zoo_sample.cfg file from the conf directory. Then rename it to zoo.cfg and change the configuration of the data and logs in it. For example:
+
+```
+dataDir=D:\\code\\apache-zookeeper-3.6.3-bin\\zkData
+dataLogDir=D:\\code\\apache-zookeeper-3.6.3-bin\\zkLog
+```
+
+v. Run zkServer.cmd in the bin, and then run zkCli.cmd to view the running status of zk. You can view the zk node information, which means the installation is successful.
+
+#### 3. Set up the back-end
+
+i. Create a new database locally for debugging. DolphinScheduler supports mysql and postgresql, here we use mysql for configuration and the database name could be : dolphinscheduler.
+
+ii. Import the code into IDEA, modify pom.xml in the root project, and change the scope of the mysql-connector-java dependency to compile.
+
+iii. Run `mvn -U install package -Prelease -Dmaven.test.skip=true `in terminal to install the required registered plugins.
+
+iv. Modify the datasource.properties of the dolphinscheduler-dao module:
+
+```properties
+# mysql
+spring.datasource.driver-class-name=com.mysql.jdbc.Driver
+spring.datasource.url=jdbc:mysql://localhost:3306/dolphinscheduler?useUnicode=true&characterEncoding=UTF-8
+spring.datasource.username=root
+spring.datasource.password=123456
+```
+
+v. Refresh the dao module and run the main method of org.apache.dolphinscheduler.dao.upgrade.shell.CreateDolphinScheduler to automatically insert the tables and data which are required by the project.
+
+vi. Modify the registry.properties of the dolphinscheduler-service module:
+
+```properties
+#registry.plugin.dir config the Registry Plugin dir.
+registry.plugin.dir=./dolphinscheduler-dist/target/dolphinscheduler-dist-1.3.6-SNAPSHOT/lib/plugin/registry/zookeeper
+
+registry.plugin.name=zookeeper
+registry.servers=127.0.0.1:2181
+```
+
+vii. Add console output to logback-worker.xml, logback-master.xml, and logback-api.xml.
+
+```xml
+<root level="INFO">
+ <appender-ref ref="STDOUT"/> <!-- 添加控制台输出 -->
+ <appender-ref ref="APILOGFILE"/>
+ <appender-ref ref="SKYWALKING-LOG"/>
+</root>
+```
+
+viii. Start MasterServer
+
+ Run the main method of org.apache.dolphinscheduler.server.master.MasterServer, you need to set the following VM options:
Review comment:
", you need" => ". You need"
##########
File path: docs/en-us/dev/user_doc/dev-run.md
##########
@@ -0,0 +1,135 @@
+## Development Environment Setup
+
+> Reference: [DolphinScheduler builds the development environment on Windows local.](https://dolphinscheduler.apache.org/zh-cn/blog/DS_run_in_windows.html)
+
+#### 1. Download source code
+
+GitHub ：https://github.com/apache/dolphinscheduler
+
+```shell
+mkdir dolphinscheduler
+cd dolphinscheduler
+git clone git@github.com:apache/dolphinscheduler.git
+```
+
+We use the dev branch here.
+
+#### 2. Windows install of zookeeper.
+
+i. Download [zookeeper](https://www.apache.org/dyn/closer.lua/zookeeper/zookeeper-3.6.3/apache-zookeeper-3.6.3-bin.tar.gz)
+
+ii. Unzip apache-zookeeper-3.6.3-bin.tar.gz
+
+iii. Create new zkData, zkLog folders in zk's directory.
+
+iv. Copy the zoo_sample.cfg file from the conf directory. Then rename it to zoo.cfg and change the configuration of the data and logs in it. For example:
+
+```
+dataDir=D:\\code\\apache-zookeeper-3.6.3-bin\\zkData
+dataLogDir=D:\\code\\apache-zookeeper-3.6.3-bin\\zkLog
+```
+
+v. Run zkServer.cmd in the bin, and then run zkCli.cmd to view the running status of zk. You can view the zk node information, which means the installation is successful.
+
+#### 3. Set up the back-end
+
+i. Create a new database locally for debugging. DolphinScheduler supports mysql and postgresql, here we use mysql for configuration and the database name could be : dolphinscheduler.
+
+ii. Import the code into IDEA, modify pom.xml in the root project, and change the scope of the mysql-connector-java dependency to compile.
+
+iii. Run `mvn -U install package -Prelease -Dmaven.test.skip=true `in terminal to install the required registered plugins.
+
+iv. Modify the datasource.properties of the dolphinscheduler-dao module:
+
+```properties
+# mysql
+spring.datasource.driver-class-name=com.mysql.jdbc.Driver
+spring.datasource.url=jdbc:mysql://localhost:3306/dolphinscheduler?useUnicode=true&characterEncoding=UTF-8
+spring.datasource.username=root
+spring.datasource.password=123456
+```
+
+v. Refresh the dao module and run the main method of org.apache.dolphinscheduler.dao.upgrade.shell.CreateDolphinScheduler to automatically insert the tables and data which are required by the project.
+
+vi. Modify the registry.properties of the dolphinscheduler-service module:
+
+```properties
+#registry.plugin.dir config the Registry Plugin dir.
+registry.plugin.dir=./dolphinscheduler-dist/target/dolphinscheduler-dist-1.3.6-SNAPSHOT/lib/plugin/registry/zookeeper
+
+registry.plugin.name=zookeeper
+registry.servers=127.0.0.1:2181
+```
+
+vii. Add console output to logback-worker.xml, logback-master.xml, and logback-api.xml.
+
+```xml
+<root level="INFO">
+ <appender-ref ref="STDOUT"/> <!-- 添加控制台输出 -->
+ <appender-ref ref="APILOGFILE"/>
+ <appender-ref ref="SKYWALKING-LOG"/>
+</root>
+```
+
+viii. Start MasterServer
+
+ Run the main method of org.apache.dolphinscheduler.server.master.MasterServer, you need to set the following VM options:
+
+```
+-Dlogging.config=classpath:logback-master.xml -Ddruid.mysql.usePingMethod=false
+```
+
+ix. Start WorkerServer
+
+run the main method of org.apache.dolphinscheduler.server.worker.WorkerServer, you need to set the following VM options:
Review comment:
", you need" => ". You need"
##########
File path: docs/en-us/dev/user_doc/dev-run.md
##########
@@ -0,0 +1,135 @@
+## Development Environment Setup
+
+> Reference: [DolphinScheduler builds the development environment on Windows local.](https://dolphinscheduler.apache.org/zh-cn/blog/DS_run_in_windows.html)
+
+#### 1. Download source code
+
+GitHub ：https://github.com/apache/dolphinscheduler
+
+```shell
+mkdir dolphinscheduler
+cd dolphinscheduler
+git clone git@github.com:apache/dolphinscheduler.git
+```
+
+We use the dev branch here.
+
+#### 2. Windows install of zookeeper.
+
+i. Download [zookeeper](https://www.apache.org/dyn/closer.lua/zookeeper/zookeeper-3.6.3/apache-zookeeper-3.6.3-bin.tar.gz)
+
+ii. Unzip apache-zookeeper-3.6.3-bin.tar.gz
+
+iii. Create new zkData, zkLog folders in zk's directory.
+
+iv. Copy the zoo_sample.cfg file from the conf directory. Then rename it to zoo.cfg and change the configuration of the data and logs in it. For example:
+
+```
+dataDir=D:\\code\\apache-zookeeper-3.6.3-bin\\zkData
+dataLogDir=D:\\code\\apache-zookeeper-3.6.3-bin\\zkLog
+```
+
+v. Run zkServer.cmd in the bin, and then run zkCli.cmd to view the running status of zk. You can view the zk node information, which means the installation is successful.
+
+#### 3. Set up the back-end
+
+i. Create a new database locally for debugging. DolphinScheduler supports mysql and postgresql, here we use mysql for configuration and the database name could be : dolphinscheduler.
+
+ii. Import the code into IDEA, modify pom.xml in the root project, and change the scope of the mysql-connector-java dependency to compile.
+
+iii. Run `mvn -U install package -Prelease -Dmaven.test.skip=true `in terminal to install the required registered plugins.
+
+iv. Modify the datasource.properties of the dolphinscheduler-dao module:
+
+```properties
+# mysql
+spring.datasource.driver-class-name=com.mysql.jdbc.Driver
+spring.datasource.url=jdbc:mysql://localhost:3306/dolphinscheduler?useUnicode=true&characterEncoding=UTF-8
+spring.datasource.username=root
+spring.datasource.password=123456
+```
+
+v. Refresh the dao module and run the main method of org.apache.dolphinscheduler.dao.upgrade.shell.CreateDolphinScheduler to automatically insert the tables and data which are required by the project.
+
+vi. Modify the registry.properties of the dolphinscheduler-service module:
+
+```properties
+#registry.plugin.dir config the Registry Plugin dir.
+registry.plugin.dir=./dolphinscheduler-dist/target/dolphinscheduler-dist-1.3.6-SNAPSHOT/lib/plugin/registry/zookeeper
+
+registry.plugin.name=zookeeper
+registry.servers=127.0.0.1:2181
+```
+
+vii. Add console output to logback-worker.xml, logback-master.xml, and logback-api.xml.
+
+```xml
+<root level="INFO">
+ <appender-ref ref="STDOUT"/> <!-- 添加控制台输出 -->
+ <appender-ref ref="APILOGFILE"/>
+ <appender-ref ref="SKYWALKING-LOG"/>
+</root>
+```
+
+viii. Start MasterServer
+
+ Run the main method of org.apache.dolphinscheduler.server.master.MasterServer, you need to set the following VM options:
+
+```
+-Dlogging.config=classpath:logback-master.xml -Ddruid.mysql.usePingMethod=false
+```
+
+ix. Start WorkerServer
Review comment:
"Start the WorkerServer"
##########
File path: docs/en-us/dev/user_doc/dev-run.md
##########
@@ -0,0 +1,135 @@
+## Development Environment Setup
+
+> Reference: [DolphinScheduler builds the development environment on Windows local.](https://dolphinscheduler.apache.org/zh-cn/blog/DS_run_in_windows.html)
+
+#### 1. Download source code
+
+GitHub ：https://github.com/apache/dolphinscheduler
+
+```shell
+mkdir dolphinscheduler
+cd dolphinscheduler
+git clone git@github.com:apache/dolphinscheduler.git
+```
+
+We use the dev branch here.
+
+#### 2. Windows install of zookeeper.
+
+i. Download [zookeeper](https://www.apache.org/dyn/closer.lua/zookeeper/zookeeper-3.6.3/apache-zookeeper-3.6.3-bin.tar.gz)
+
+ii. Unzip apache-zookeeper-3.6.3-bin.tar.gz
+
+iii. Create new zkData, zkLog folders in zk's directory.
+
+iv. Copy the zoo_sample.cfg file from the conf directory. Then rename it to zoo.cfg and change the configuration of the data and logs in it. For example:
+
+```
+dataDir=D:\\code\\apache-zookeeper-3.6.3-bin\\zkData
+dataLogDir=D:\\code\\apache-zookeeper-3.6.3-bin\\zkLog
+```
+
+v. Run zkServer.cmd in the bin, and then run zkCli.cmd to view the running status of zk. You can view the zk node information, which means the installation is successful.
+
+#### 3. Set up the back-end
+
+i. Create a new database locally for debugging. DolphinScheduler supports mysql and postgresql, here we use mysql for configuration and the database name could be : dolphinscheduler.
+
+ii. Import the code into IDEA, modify pom.xml in the root project, and change the scope of the mysql-connector-java dependency to compile.
+
+iii. Run `mvn -U install package -Prelease -Dmaven.test.skip=true `in terminal to install the required registered plugins.
+
+iv. Modify the datasource.properties of the dolphinscheduler-dao module:
+
+```properties
+# mysql
+spring.datasource.driver-class-name=com.mysql.jdbc.Driver
+spring.datasource.url=jdbc:mysql://localhost:3306/dolphinscheduler?useUnicode=true&characterEncoding=UTF-8
+spring.datasource.username=root
+spring.datasource.password=123456
+```
+
+v. Refresh the dao module and run the main method of org.apache.dolphinscheduler.dao.upgrade.shell.CreateDolphinScheduler to automatically insert the tables and data which are required by the project.
+
+vi. Modify the registry.properties of the dolphinscheduler-service module:
+
+```properties
+#registry.plugin.dir config the Registry Plugin dir.
+registry.plugin.dir=./dolphinscheduler-dist/target/dolphinscheduler-dist-1.3.6-SNAPSHOT/lib/plugin/registry/zookeeper
+
+registry.plugin.name=zookeeper
+registry.servers=127.0.0.1:2181
+```
+
+vii. Add console output to logback-worker.xml, logback-master.xml, and logback-api.xml.
+
+```xml
+<root level="INFO">
+ <appender-ref ref="STDOUT"/> <!-- 添加控制台输出 -->
+ <appender-ref ref="APILOGFILE"/>
+ <appender-ref ref="SKYWALKING-LOG"/>
+</root>
+```
+
+viii. Start MasterServer
+
+ Run the main method of org.apache.dolphinscheduler.server.master.MasterServer, you need to set the following VM options:
+
+```
+-Dlogging.config=classpath:logback-master.xml -Ddruid.mysql.usePingMethod=false
+```
+
+ix. Start WorkerServer
+
+run the main method of org.apache.dolphinscheduler.server.worker.WorkerServer, you need to set the following VM options:
+
+```
+-Dlogging.config=classpath:logback-worker.xml -Ddruid.mysql.usePingMethod=false
+```
+
+x. Start ApiApplicationServer
+
+run the main method of org.apache.dolphinscheduler.api.ApiApplicationServer, you need to set the following VM options:
+
+```
+-Dlogging.config=classpath:logback-api.xml -Dspring.profiles.active=api
+```
+
+xi. If you need to use the log function, execute the main method of org.apache.dolphinscheduler.server.log.LoggerServer.
+
+xii. Backend swagger address: http://localhost:12345/dolphinscheduler/doc.html?language=zh_CN&lang=cn
+
+#### 4. Set up the front-end
+
+i. Install node
+
+ a. Install nvm
+
+curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.37.2/install.sh | bash
+
+ b. Refresh the environment variables
+
+ source ~/.bash_profile
+
+ c. Install node
+
+ nvm install v12.20.2 note: Mac users could install npm through brew: brew install npm
Review comment:
"note: ..." should be set in a new line I think.
--
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.
To unsubscribe, e-mail: commits-unsubscribe@dolphinscheduler.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [dolphinscheduler-website] QuakeWang commented on pull request #416: [SOC] Translate the dev-run page
Posted by GitBox <gi...@apache.org>.
QuakeWang commented on pull request #416:
URL: https://github.com/apache/dolphinscheduler-website/pull/416#issuecomment-892576844
@ptyp PTAL
--
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.
To unsubscribe, e-mail: commits-unsubscribe@dolphinscheduler.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [dolphinscheduler-website] CalvinKirs merged pull request #416: [SOC] Translate the dev-run page
Posted by GitBox <gi...@apache.org>.
CalvinKirs merged pull request #416:
URL: https://github.com/apache/dolphinscheduler-website/pull/416
--
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.
To unsubscribe, e-mail: commits-unsubscribe@dolphinscheduler.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org