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 2022/05/18 15:49:04 UTC
[GitHub] [dolphinscheduler] EricGao888 opened a new pull request, #10107: [Bug][Doc]Update project directory structure in docs
EricGao888 opened a new pull request, #10107:
URL: https://github.com/apache/dolphinscheduler/pull/10107
## Purpose of the pull request
* Update project directory structure in docs, see https://github.com/apache/dolphinscheduler/blob/dev/docs/docs/en/architecture/configuration.md
* This PR closes: #9670
## Brief change log
* Already described above
## Verify this pull request
--
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] EricGao888 commented on pull request #10107: [Bug][Doc]Update project directory structure in docs
Posted by GitBox <gi...@apache.org>.
EricGao888 commented on PR #10107:
URL: https://github.com/apache/dolphinscheduler/pull/10107#issuecomment-1130198355
Still WIP. Since v3.0.0 refactors the project in `microservices` architecture, there are several duplicate scripts and configs across modules. I've updated the project structure in English doc and hope to get some reviews. If it looks fine, I will update the Chinese doc in the next commit. Thx : )
--
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] EricGao888 commented on pull request #10107: [Bug][Doc]Update project directory structure in docs
Posted by GitBox <gi...@apache.org>.
EricGao888 commented on PR #10107:
URL: https://github.com/apache/dolphinscheduler/pull/10107#issuecomment-1132405176
> @EricGao888 Do you have time to complete this PR recently? we are going to release 3.0.0-beta-1 next week
Yes, I'm working on it.
--
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] zhongjiajie commented on pull request #10107: [Bug][Doc]Update project directory structure in docs
Posted by GitBox <gi...@apache.org>.
zhongjiajie commented on PR #10107:
URL: https://github.com/apache/dolphinscheduler/pull/10107#issuecomment-1131046041
Looking great! will take a look this date later 👍
--
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] zhongjiajie merged pull request #10107: [Bug][Doc]Update project directory structure in docs
Posted by GitBox <gi...@apache.org>.
zhongjiajie merged PR #10107:
URL: https://github.com/apache/dolphinscheduler/pull/10107
--
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] EricGao888 commented on pull request #10107: [Bug][Doc]Update project directory structure in docs
Posted by GitBox <gi...@apache.org>.
EricGao888 commented on PR #10107:
URL: https://github.com/apache/dolphinscheduler/pull/10107#issuecomment-1133609065
> > > @EricGao888 Do you have time to complete this PR recently? we are going to release 3.0.0-beta-1 next week
>
> >
>
> > @zhongjiajie Comments resolved, but need to double check the description for ui folders under standalone-server and api-server. Will update the Chinese doc in next commit if it looks good to you.
>
>
>
> LGTM, please also change the ZH docs, thanks
Sure, thx
--
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] EricGao888 commented on pull request #10107: [Bug][Doc]Update project directory structure in docs
Posted by GitBox <gi...@apache.org>.
EricGao888 commented on PR #10107:
URL: https://github.com/apache/dolphinscheduler/pull/10107#issuecomment-1133634147
> > > @EricGao888 Do you have time to complete this PR recently? we are going to release 3.0.0-beta-1 next week
> >
> >
> > @zhongjiajie Comments resolved, but need to double check the description for ui folders under standalone-server and api-server. Will update the Chinese doc in next commit if it looks good to you.
>
> LGTM, please also change the ZH docs, thanks
Done, PTAL Thx : )
--
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] EricGao888 commented on a diff in pull request #10107: [Bug][Doc]Update project directory structure in docs
Posted by GitBox <gi...@apache.org>.
EricGao888 commented on code in PR #10107:
URL: https://github.com/apache/dolphinscheduler/pull/10107#discussion_r876649737
##########
docs/docs/en/architecture/configuration.md:
##########
@@ -15,44 +15,87 @@ This document only describes DolphinScheduler configurations and other topics ar
[Note: the DolphinScheduler (hereinafter called the ‘DS’) .]
```
-├─bin DS application commands directory
-│ ├─dolphinscheduler-daemon.sh startup or shutdown DS application
-│ ├─start-all.sh startup all DS services with configurations
-│ ├─stop-all.sh shutdown all DS services with configurations
-├─conf configurations directory
-│ ├─application-api.properties API-service config properties
-│ ├─datasource.properties datasource config properties
-│ ├─zookeeper.properties ZooKeeper config properties
-│ ├─master.properties master-service config properties
-│ ├─worker.properties worker-service config properties
-│ ├─quartz.properties quartz config properties
-│ ├─common.properties common-service [storage] config properties
-│ ├─alert.properties alert-service config properties
-│ ├─config environment variables config directory
-│ ├─install_config.conf DS environment variables configuration script [install or start DS]
-│ ├─env load environment variables configs script directory
-│ ├─dolphinscheduler_env.sh load environment variables configs [eg: JAVA_HOME,HADOOP_HOME, HIVE_HOME ...]
-│ ├─org mybatis mapper files directory
-│ ├─i18n i18n configs directory
-│ ├─logback-api.xml API-service log config
-│ ├─logback-master.xml master-service log config
-│ ├─logback-worker.xml worker-service log config
-│ ├─logback-alert.xml alert-service log config
-├─sql .sql files to create or upgrade DS metadata
-│ ├─create create SQL scripts directory
-│ ├─upgrade upgrade SQL scripts directory
-│ ├─dolphinscheduler_postgre.sql PostgreSQL database init script
-│ ├─dolphinscheduler_mysql.sql MySQL database init script
-│ ├─soft_version current DS version-id file
-├─script DS services deployment, database create or upgrade scripts directory
-│ ├─create-dolphinscheduler.sh DS database init script
-│ ├─upgrade-dolphinscheduler.sh DS database upgrade script
-│ ├─monitor-server.sh DS monitor-server start script
-│ ├─scp-hosts.sh transfer installation files script
-│ ├─remove-zk-node.sh cleanup ZooKeeper caches script
-├─ui front-end web resources directory
-├─lib DS .jar dependencies directory
-├─install.sh auto-setup DS services script
+├── LICENSE
+│
+├── NOTICE
+│
+├── licenses directory of licenses
+│
+├── bin directory of DS application commands, configrations scripts
Review Comment:
Sure, seems we also need to delete https://github.com/apache/dolphinscheduler/blob/243ee8ba70d50c7d4b251fd43a4c150606014b8b/docs/docs/en/architecture/configuration.md?plain=1#L15
--
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] zhongjiajie commented on pull request #10107: [Bug][Doc]Update project directory structure in docs
Posted by GitBox <gi...@apache.org>.
zhongjiajie commented on PR #10107:
URL: https://github.com/apache/dolphinscheduler/pull/10107#issuecomment-1132399062
@EricGao888 Do you have time to complete this PR recently? we are going to release 3.0.0-beta-1 next week
--
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] EricGao888 commented on a diff in pull request #10107: [Bug][Doc]Update project directory structure in docs
Posted by GitBox <gi...@apache.org>.
EricGao888 commented on code in PR #10107:
URL: https://github.com/apache/dolphinscheduler/pull/10107#discussion_r876650220
##########
docs/docs/en/architecture/configuration.md:
##########
@@ -15,44 +15,87 @@ This document only describes DolphinScheduler configurations and other topics ar
[Note: the DolphinScheduler (hereinafter called the ‘DS’) .]
```
-├─bin DS application commands directory
-│ ├─dolphinscheduler-daemon.sh startup or shutdown DS application
-│ ├─start-all.sh startup all DS services with configurations
-│ ├─stop-all.sh shutdown all DS services with configurations
-├─conf configurations directory
-│ ├─application-api.properties API-service config properties
-│ ├─datasource.properties datasource config properties
-│ ├─zookeeper.properties ZooKeeper config properties
-│ ├─master.properties master-service config properties
-│ ├─worker.properties worker-service config properties
-│ ├─quartz.properties quartz config properties
-│ ├─common.properties common-service [storage] config properties
-│ ├─alert.properties alert-service config properties
-│ ├─config environment variables config directory
-│ ├─install_config.conf DS environment variables configuration script [install or start DS]
-│ ├─env load environment variables configs script directory
-│ ├─dolphinscheduler_env.sh load environment variables configs [eg: JAVA_HOME,HADOOP_HOME, HIVE_HOME ...]
-│ ├─org mybatis mapper files directory
-│ ├─i18n i18n configs directory
-│ ├─logback-api.xml API-service log config
-│ ├─logback-master.xml master-service log config
-│ ├─logback-worker.xml worker-service log config
-│ ├─logback-alert.xml alert-service log config
-├─sql .sql files to create or upgrade DS metadata
-│ ├─create create SQL scripts directory
-│ ├─upgrade upgrade SQL scripts directory
-│ ├─dolphinscheduler_postgre.sql PostgreSQL database init script
-│ ├─dolphinscheduler_mysql.sql MySQL database init script
-│ ├─soft_version current DS version-id file
-├─script DS services deployment, database create or upgrade scripts directory
-│ ├─create-dolphinscheduler.sh DS database init script
-│ ├─upgrade-dolphinscheduler.sh DS database upgrade script
-│ ├─monitor-server.sh DS monitor-server start script
-│ ├─scp-hosts.sh transfer installation files script
-│ ├─remove-zk-node.sh cleanup ZooKeeper caches script
-├─ui front-end web resources directory
-├─lib DS .jar dependencies directory
-├─install.sh auto-setup DS services script
+├── LICENSE
+│
+├── NOTICE
+│
+├── licenses directory of licenses
+│
+├── bin directory of DS application commands, configrations scripts
+│ ├── dolphinscheduler-daemon.sh script to start or shut down DS application
+│ ├── env directory of scripts to load environment variables
+│ │ ├── dolphinscheduler_env.sh script to load environment variables [eg: JAVA_HOME,HADOOP_HOME, HIVE_HOME ...]
Review Comment:
Thx, will fix it in the next commit.
--
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] zhongjiajie commented on a diff in pull request #10107: [Bug][Doc]Update project directory structure in docs
Posted by GitBox <gi...@apache.org>.
zhongjiajie commented on code in PR #10107:
URL: https://github.com/apache/dolphinscheduler/pull/10107#discussion_r876634445
##########
docs/docs/en/architecture/configuration.md:
##########
@@ -15,44 +15,87 @@ This document only describes DolphinScheduler configurations and other topics ar
[Note: the DolphinScheduler (hereinafter called the ‘DS’) .]
```
-├─bin DS application commands directory
-│ ├─dolphinscheduler-daemon.sh startup or shutdown DS application
-│ ├─start-all.sh startup all DS services with configurations
-│ ├─stop-all.sh shutdown all DS services with configurations
-├─conf configurations directory
-│ ├─application-api.properties API-service config properties
-│ ├─datasource.properties datasource config properties
-│ ├─zookeeper.properties ZooKeeper config properties
-│ ├─master.properties master-service config properties
-│ ├─worker.properties worker-service config properties
-│ ├─quartz.properties quartz config properties
-│ ├─common.properties common-service [storage] config properties
-│ ├─alert.properties alert-service config properties
-│ ├─config environment variables config directory
-│ ├─install_config.conf DS environment variables configuration script [install or start DS]
-│ ├─env load environment variables configs script directory
-│ ├─dolphinscheduler_env.sh load environment variables configs [eg: JAVA_HOME,HADOOP_HOME, HIVE_HOME ...]
-│ ├─org mybatis mapper files directory
-│ ├─i18n i18n configs directory
-│ ├─logback-api.xml API-service log config
-│ ├─logback-master.xml master-service log config
-│ ├─logback-worker.xml worker-service log config
-│ ├─logback-alert.xml alert-service log config
-├─sql .sql files to create or upgrade DS metadata
-│ ├─create create SQL scripts directory
-│ ├─upgrade upgrade SQL scripts directory
-│ ├─dolphinscheduler_postgre.sql PostgreSQL database init script
-│ ├─dolphinscheduler_mysql.sql MySQL database init script
-│ ├─soft_version current DS version-id file
-├─script DS services deployment, database create or upgrade scripts directory
-│ ├─create-dolphinscheduler.sh DS database init script
-│ ├─upgrade-dolphinscheduler.sh DS database upgrade script
-│ ├─monitor-server.sh DS monitor-server start script
-│ ├─scp-hosts.sh transfer installation files script
-│ ├─remove-zk-node.sh cleanup ZooKeeper caches script
-├─ui front-end web resources directory
-├─lib DS .jar dependencies directory
-├─install.sh auto-setup DS services script
+├── LICENSE
+│
+├── NOTICE
+│
+├── licenses directory of licenses
+│
+├── bin directory of DS application commands, configrations scripts
+│ ├── dolphinscheduler-daemon.sh script to start or shut down DS application
+│ ├── env directory of scripts to load environment variables
+│ │ ├── dolphinscheduler_env.sh script to load environment variables [eg: JAVA_HOME,HADOOP_HOME, HIVE_HOME ...]
Review Comment:
```suggestion
│ │ ├── dolphinscheduler_env.sh script to load environment variables [eg: JAVA_HOME,HADOOP_HOME, HIVE_HOME ...], will export them when you start or stop service using script `dolphinscheduler-daemon.sh`
```
##########
docs/docs/en/architecture/configuration.md:
##########
@@ -15,44 +15,87 @@ This document only describes DolphinScheduler configurations and other topics ar
[Note: the DolphinScheduler (hereinafter called the ‘DS’) .]
```
-├─bin DS application commands directory
-│ ├─dolphinscheduler-daemon.sh startup or shutdown DS application
-│ ├─start-all.sh startup all DS services with configurations
-│ ├─stop-all.sh shutdown all DS services with configurations
-├─conf configurations directory
-│ ├─application-api.properties API-service config properties
-│ ├─datasource.properties datasource config properties
-│ ├─zookeeper.properties ZooKeeper config properties
-│ ├─master.properties master-service config properties
-│ ├─worker.properties worker-service config properties
-│ ├─quartz.properties quartz config properties
-│ ├─common.properties common-service [storage] config properties
-│ ├─alert.properties alert-service config properties
-│ ├─config environment variables config directory
-│ ├─install_config.conf DS environment variables configuration script [install or start DS]
-│ ├─env load environment variables configs script directory
-│ ├─dolphinscheduler_env.sh load environment variables configs [eg: JAVA_HOME,HADOOP_HOME, HIVE_HOME ...]
-│ ├─org mybatis mapper files directory
-│ ├─i18n i18n configs directory
-│ ├─logback-api.xml API-service log config
-│ ├─logback-master.xml master-service log config
-│ ├─logback-worker.xml worker-service log config
-│ ├─logback-alert.xml alert-service log config
-├─sql .sql files to create or upgrade DS metadata
-│ ├─create create SQL scripts directory
-│ ├─upgrade upgrade SQL scripts directory
-│ ├─dolphinscheduler_postgre.sql PostgreSQL database init script
-│ ├─dolphinscheduler_mysql.sql MySQL database init script
-│ ├─soft_version current DS version-id file
-├─script DS services deployment, database create or upgrade scripts directory
-│ ├─create-dolphinscheduler.sh DS database init script
-│ ├─upgrade-dolphinscheduler.sh DS database upgrade script
-│ ├─monitor-server.sh DS monitor-server start script
-│ ├─scp-hosts.sh transfer installation files script
-│ ├─remove-zk-node.sh cleanup ZooKeeper caches script
-├─ui front-end web resources directory
-├─lib DS .jar dependencies directory
-├─install.sh auto-setup DS services script
+├── LICENSE
+│
+├── NOTICE
+│
+├── licenses directory of licenses
+│
+├── bin directory of DS application commands, configrations scripts
Review Comment:
We should avoid using the shortcut for product name in our document
```suggestion
├── bin directory of DolphinScheduler application commands, configrations scripts
```
##########
docs/docs/en/architecture/configuration.md:
##########
@@ -15,44 +15,87 @@ This document only describes DolphinScheduler configurations and other topics ar
[Note: the DolphinScheduler (hereinafter called the ‘DS’) .]
```
-├─bin DS application commands directory
-│ ├─dolphinscheduler-daemon.sh startup or shutdown DS application
-│ ├─start-all.sh startup all DS services with configurations
-│ ├─stop-all.sh shutdown all DS services with configurations
-├─conf configurations directory
-│ ├─application-api.properties API-service config properties
-│ ├─datasource.properties datasource config properties
-│ ├─zookeeper.properties ZooKeeper config properties
-│ ├─master.properties master-service config properties
-│ ├─worker.properties worker-service config properties
-│ ├─quartz.properties quartz config properties
-│ ├─common.properties common-service [storage] config properties
-│ ├─alert.properties alert-service config properties
-│ ├─config environment variables config directory
-│ ├─install_config.conf DS environment variables configuration script [install or start DS]
-│ ├─env load environment variables configs script directory
-│ ├─dolphinscheduler_env.sh load environment variables configs [eg: JAVA_HOME,HADOOP_HOME, HIVE_HOME ...]
-│ ├─org mybatis mapper files directory
-│ ├─i18n i18n configs directory
-│ ├─logback-api.xml API-service log config
-│ ├─logback-master.xml master-service log config
-│ ├─logback-worker.xml worker-service log config
-│ ├─logback-alert.xml alert-service log config
-├─sql .sql files to create or upgrade DS metadata
-│ ├─create create SQL scripts directory
-│ ├─upgrade upgrade SQL scripts directory
-│ ├─dolphinscheduler_postgre.sql PostgreSQL database init script
-│ ├─dolphinscheduler_mysql.sql MySQL database init script
-│ ├─soft_version current DS version-id file
-├─script DS services deployment, database create or upgrade scripts directory
-│ ├─create-dolphinscheduler.sh DS database init script
-│ ├─upgrade-dolphinscheduler.sh DS database upgrade script
-│ ├─monitor-server.sh DS monitor-server start script
-│ ├─scp-hosts.sh transfer installation files script
-│ ├─remove-zk-node.sh cleanup ZooKeeper caches script
-├─ui front-end web resources directory
-├─lib DS .jar dependencies directory
-├─install.sh auto-setup DS services script
+├── LICENSE
+│
+├── NOTICE
+│
+├── licenses directory of licenses
+│
+├── bin directory of DS application commands, configrations scripts
+│ ├── dolphinscheduler-daemon.sh script to start or shut down DS application
+│ ├── env directory of scripts to load environment variables
+│ │ ├── dolphinscheduler_env.sh script to load environment variables [eg: JAVA_HOME,HADOOP_HOME, HIVE_HOME ...]
+│ │ └── install_env.sh script to load environment variables for DS installation
+│ ├── install.sh script to auto-setup DS services
+│ ├── remove-zk-node.sh script to cleanup ZooKeeper caches
+│ ├── scp-hosts.sh script to copy installation files to target hosts
+│ ├── start-all.sh script to start all DS services
+│ ├── status-all.sh script to check the status of all DS services
+│ └── stop-all.sh script to shut down all DS services
+│
+├── alert-server directory of DS alert-server commands, configrations scripts and libs
+│ ├── bin
+│ │ └── start.sh script to start DS alert-server
+│ ├── conf
+│ │ ├── application.yaml configurations of alert-server
+│ │ ├── common.properties configurations of common-service like storage, credentials, etc.
+│ │ ├── dolphinscheduler_env.sh script to load environment variables for alert-server
+│ │ └── logback-spring.xml configurations of alert-service log
+│ └── libs directory of alert-server libs
+│
+├── api-server directory of DS api-server commands, configrations scripts and libs
+│ ├── bin
+│ │ └── start.sh script to start DS api-server
+│ ├── conf
+│ │ ├── application.yaml configurations of api-server
+│ │ ├── common.properties configurations of common-service like storage, credentials, etc.
+│ │ ├── dolphinscheduler_env.sh script to load environment variables for api-server
+│ │ └── logback-spring.xml configurations of api-service log
+│ ├── libs directory of api-server libs
+│ └── ui
+│
+├── master-server directory of DS master-server commands, configrations scripts and libs
+│ ├── bin
+│ │ └── start.sh script to start DS master-server
+│ ├── conf
+│ │ ├── application.yaml configurations of master-server
+│ │ ├── common.properties configurations of common-service like storage, credentials, etc.
+│ │ ├── dolphinscheduler_env.sh script to load environment variables for master-server
+│ │ └── logback-spring.xml configurations of master-service log
+│ └── libs directory of master-server libs
+│
+├── standalone-server directory of DS standalone-server commands, configrations scripts and libs
Review Comment:
```suggestion
├── standalone-server directory of DS standalone-server commands, configrations scripts and libs
```
##########
docs/docs/en/architecture/configuration.md:
##########
@@ -15,44 +15,87 @@ This document only describes DolphinScheduler configurations and other topics ar
[Note: the DolphinScheduler (hereinafter called the ‘DS’) .]
```
-├─bin DS application commands directory
-│ ├─dolphinscheduler-daemon.sh startup or shutdown DS application
-│ ├─start-all.sh startup all DS services with configurations
-│ ├─stop-all.sh shutdown all DS services with configurations
-├─conf configurations directory
-│ ├─application-api.properties API-service config properties
-│ ├─datasource.properties datasource config properties
-│ ├─zookeeper.properties ZooKeeper config properties
-│ ├─master.properties master-service config properties
-│ ├─worker.properties worker-service config properties
-│ ├─quartz.properties quartz config properties
-│ ├─common.properties common-service [storage] config properties
-│ ├─alert.properties alert-service config properties
-│ ├─config environment variables config directory
-│ ├─install_config.conf DS environment variables configuration script [install or start DS]
-│ ├─env load environment variables configs script directory
-│ ├─dolphinscheduler_env.sh load environment variables configs [eg: JAVA_HOME,HADOOP_HOME, HIVE_HOME ...]
-│ ├─org mybatis mapper files directory
-│ ├─i18n i18n configs directory
-│ ├─logback-api.xml API-service log config
-│ ├─logback-master.xml master-service log config
-│ ├─logback-worker.xml worker-service log config
-│ ├─logback-alert.xml alert-service log config
-├─sql .sql files to create or upgrade DS metadata
-│ ├─create create SQL scripts directory
-│ ├─upgrade upgrade SQL scripts directory
-│ ├─dolphinscheduler_postgre.sql PostgreSQL database init script
-│ ├─dolphinscheduler_mysql.sql MySQL database init script
-│ ├─soft_version current DS version-id file
-├─script DS services deployment, database create or upgrade scripts directory
-│ ├─create-dolphinscheduler.sh DS database init script
-│ ├─upgrade-dolphinscheduler.sh DS database upgrade script
-│ ├─monitor-server.sh DS monitor-server start script
-│ ├─scp-hosts.sh transfer installation files script
-│ ├─remove-zk-node.sh cleanup ZooKeeper caches script
-├─ui front-end web resources directory
-├─lib DS .jar dependencies directory
-├─install.sh auto-setup DS services script
+├── LICENSE
+│
+├── NOTICE
+│
+├── licenses directory of licenses
+│
+├── bin directory of DS application commands, configrations scripts
+│ ├── dolphinscheduler-daemon.sh script to start or shut down DS application
+│ ├── env directory of scripts to load environment variables
+│ │ ├── dolphinscheduler_env.sh script to load environment variables [eg: JAVA_HOME,HADOOP_HOME, HIVE_HOME ...]
+│ │ └── install_env.sh script to load environment variables for DS installation
+│ ├── install.sh script to auto-setup DS services
+│ ├── remove-zk-node.sh script to cleanup ZooKeeper caches
+│ ├── scp-hosts.sh script to copy installation files to target hosts
+│ ├── start-all.sh script to start all DS services
+│ ├── status-all.sh script to check the status of all DS services
+│ └── stop-all.sh script to shut down all DS services
+│
+├── alert-server directory of DS alert-server commands, configrations scripts and libs
+│ ├── bin
+│ │ └── start.sh script to start DS alert-server
+│ ├── conf
+│ │ ├── application.yaml configurations of alert-server
+│ │ ├── common.properties configurations of common-service like storage, credentials, etc.
+│ │ ├── dolphinscheduler_env.sh script to load environment variables for alert-server
+│ │ └── logback-spring.xml configurations of alert-service log
+│ └── libs directory of alert-server libs
+│
+├── api-server directory of DS api-server commands, configrations scripts and libs
+│ ├── bin
+│ │ └── start.sh script to start DS api-server
+│ ├── conf
+│ │ ├── application.yaml configurations of api-server
+│ │ ├── common.properties configurations of common-service like storage, credentials, etc.
+│ │ ├── dolphinscheduler_env.sh script to load environment variables for api-server
+│ │ └── logback-spring.xml configurations of api-service log
+│ ├── libs directory of api-server libs
+│ └── ui
Review Comment:
should we also add some description about `ui` component
##########
docs/docs/en/architecture/configuration.md:
##########
@@ -15,44 +15,87 @@ This document only describes DolphinScheduler configurations and other topics ar
[Note: the DolphinScheduler (hereinafter called the ‘DS’) .]
```
-├─bin DS application commands directory
-│ ├─dolphinscheduler-daemon.sh startup or shutdown DS application
-│ ├─start-all.sh startup all DS services with configurations
-│ ├─stop-all.sh shutdown all DS services with configurations
-├─conf configurations directory
-│ ├─application-api.properties API-service config properties
-│ ├─datasource.properties datasource config properties
-│ ├─zookeeper.properties ZooKeeper config properties
-│ ├─master.properties master-service config properties
-│ ├─worker.properties worker-service config properties
-│ ├─quartz.properties quartz config properties
-│ ├─common.properties common-service [storage] config properties
-│ ├─alert.properties alert-service config properties
-│ ├─config environment variables config directory
-│ ├─install_config.conf DS environment variables configuration script [install or start DS]
-│ ├─env load environment variables configs script directory
-│ ├─dolphinscheduler_env.sh load environment variables configs [eg: JAVA_HOME,HADOOP_HOME, HIVE_HOME ...]
-│ ├─org mybatis mapper files directory
-│ ├─i18n i18n configs directory
-│ ├─logback-api.xml API-service log config
-│ ├─logback-master.xml master-service log config
-│ ├─logback-worker.xml worker-service log config
-│ ├─logback-alert.xml alert-service log config
-├─sql .sql files to create or upgrade DS metadata
-│ ├─create create SQL scripts directory
-│ ├─upgrade upgrade SQL scripts directory
-│ ├─dolphinscheduler_postgre.sql PostgreSQL database init script
-│ ├─dolphinscheduler_mysql.sql MySQL database init script
-│ ├─soft_version current DS version-id file
-├─script DS services deployment, database create or upgrade scripts directory
-│ ├─create-dolphinscheduler.sh DS database init script
-│ ├─upgrade-dolphinscheduler.sh DS database upgrade script
-│ ├─monitor-server.sh DS monitor-server start script
-│ ├─scp-hosts.sh transfer installation files script
-│ ├─remove-zk-node.sh cleanup ZooKeeper caches script
-├─ui front-end web resources directory
-├─lib DS .jar dependencies directory
-├─install.sh auto-setup DS services script
+├── LICENSE
+│
+├── NOTICE
+│
+├── licenses directory of licenses
+│
+├── bin directory of DS application commands, configrations scripts
Review Comment:
same as other keyword below
##########
docs/docs/en/architecture/configuration.md:
##########
@@ -15,44 +15,87 @@ This document only describes DolphinScheduler configurations and other topics ar
[Note: the DolphinScheduler (hereinafter called the ‘DS’) .]
```
-├─bin DS application commands directory
-│ ├─dolphinscheduler-daemon.sh startup or shutdown DS application
-│ ├─start-all.sh startup all DS services with configurations
-│ ├─stop-all.sh shutdown all DS services with configurations
-├─conf configurations directory
-│ ├─application-api.properties API-service config properties
-│ ├─datasource.properties datasource config properties
-│ ├─zookeeper.properties ZooKeeper config properties
-│ ├─master.properties master-service config properties
-│ ├─worker.properties worker-service config properties
-│ ├─quartz.properties quartz config properties
-│ ├─common.properties common-service [storage] config properties
-│ ├─alert.properties alert-service config properties
-│ ├─config environment variables config directory
-│ ├─install_config.conf DS environment variables configuration script [install or start DS]
-│ ├─env load environment variables configs script directory
-│ ├─dolphinscheduler_env.sh load environment variables configs [eg: JAVA_HOME,HADOOP_HOME, HIVE_HOME ...]
-│ ├─org mybatis mapper files directory
-│ ├─i18n i18n configs directory
-│ ├─logback-api.xml API-service log config
-│ ├─logback-master.xml master-service log config
-│ ├─logback-worker.xml worker-service log config
-│ ├─logback-alert.xml alert-service log config
-├─sql .sql files to create or upgrade DS metadata
-│ ├─create create SQL scripts directory
-│ ├─upgrade upgrade SQL scripts directory
-│ ├─dolphinscheduler_postgre.sql PostgreSQL database init script
-│ ├─dolphinscheduler_mysql.sql MySQL database init script
-│ ├─soft_version current DS version-id file
-├─script DS services deployment, database create or upgrade scripts directory
-│ ├─create-dolphinscheduler.sh DS database init script
-│ ├─upgrade-dolphinscheduler.sh DS database upgrade script
-│ ├─monitor-server.sh DS monitor-server start script
-│ ├─scp-hosts.sh transfer installation files script
-│ ├─remove-zk-node.sh cleanup ZooKeeper caches script
-├─ui front-end web resources directory
-├─lib DS .jar dependencies directory
-├─install.sh auto-setup DS services script
+├── LICENSE
+│
+├── NOTICE
+│
+├── licenses directory of licenses
+│
+├── bin directory of DS application commands, configrations scripts
+│ ├── dolphinscheduler-daemon.sh script to start or shut down DS application
+│ ├── env directory of scripts to load environment variables
+│ │ ├── dolphinscheduler_env.sh script to load environment variables [eg: JAVA_HOME,HADOOP_HOME, HIVE_HOME ...]
+│ │ └── install_env.sh script to load environment variables for DS installation
Review Comment:
```suggestion
│ │ └── install_env.sh script to load environment variables for DS installation, will export them when you using script `install.sh` `start-all.sh` `stop-all.sh` `status-all.sh`
```
##########
docs/docs/en/architecture/configuration.md:
##########
@@ -15,44 +15,87 @@ This document only describes DolphinScheduler configurations and other topics ar
[Note: the DolphinScheduler (hereinafter called the ‘DS’) .]
```
-├─bin DS application commands directory
-│ ├─dolphinscheduler-daemon.sh startup or shutdown DS application
-│ ├─start-all.sh startup all DS services with configurations
-│ ├─stop-all.sh shutdown all DS services with configurations
-├─conf configurations directory
-│ ├─application-api.properties API-service config properties
-│ ├─datasource.properties datasource config properties
-│ ├─zookeeper.properties ZooKeeper config properties
-│ ├─master.properties master-service config properties
-│ ├─worker.properties worker-service config properties
-│ ├─quartz.properties quartz config properties
-│ ├─common.properties common-service [storage] config properties
-│ ├─alert.properties alert-service config properties
-│ ├─config environment variables config directory
-│ ├─install_config.conf DS environment variables configuration script [install or start DS]
-│ ├─env load environment variables configs script directory
-│ ├─dolphinscheduler_env.sh load environment variables configs [eg: JAVA_HOME,HADOOP_HOME, HIVE_HOME ...]
-│ ├─org mybatis mapper files directory
-│ ├─i18n i18n configs directory
-│ ├─logback-api.xml API-service log config
-│ ├─logback-master.xml master-service log config
-│ ├─logback-worker.xml worker-service log config
-│ ├─logback-alert.xml alert-service log config
-├─sql .sql files to create or upgrade DS metadata
-│ ├─create create SQL scripts directory
-│ ├─upgrade upgrade SQL scripts directory
-│ ├─dolphinscheduler_postgre.sql PostgreSQL database init script
-│ ├─dolphinscheduler_mysql.sql MySQL database init script
-│ ├─soft_version current DS version-id file
-├─script DS services deployment, database create or upgrade scripts directory
-│ ├─create-dolphinscheduler.sh DS database init script
-│ ├─upgrade-dolphinscheduler.sh DS database upgrade script
-│ ├─monitor-server.sh DS monitor-server start script
-│ ├─scp-hosts.sh transfer installation files script
-│ ├─remove-zk-node.sh cleanup ZooKeeper caches script
-├─ui front-end web resources directory
-├─lib DS .jar dependencies directory
-├─install.sh auto-setup DS services script
+├── LICENSE
+│
+├── NOTICE
+│
+├── licenses directory of licenses
+│
+├── bin directory of DS application commands, configrations scripts
+│ ├── dolphinscheduler-daemon.sh script to start or shut down DS application
+│ ├── env directory of scripts to load environment variables
+│ │ ├── dolphinscheduler_env.sh script to load environment variables [eg: JAVA_HOME,HADOOP_HOME, HIVE_HOME ...]
+│ │ └── install_env.sh script to load environment variables for DS installation
+│ ├── install.sh script to auto-setup DS services
+│ ├── remove-zk-node.sh script to cleanup ZooKeeper caches
+│ ├── scp-hosts.sh script to copy installation files to target hosts
+│ ├── start-all.sh script to start all DS services
+│ ├── status-all.sh script to check the status of all DS services
+│ └── stop-all.sh script to shut down all DS services
Review Comment:
```suggestion
│ └── stop-all.sh script to shut down all DS services, use when you deploy with pseudo-cluster mode or cluster mode
```
##########
docs/docs/en/architecture/configuration.md:
##########
@@ -15,44 +15,87 @@ This document only describes DolphinScheduler configurations and other topics ar
[Note: the DolphinScheduler (hereinafter called the ‘DS’) .]
```
-├─bin DS application commands directory
-│ ├─dolphinscheduler-daemon.sh startup or shutdown DS application
-│ ├─start-all.sh startup all DS services with configurations
-│ ├─stop-all.sh shutdown all DS services with configurations
-├─conf configurations directory
-│ ├─application-api.properties API-service config properties
-│ ├─datasource.properties datasource config properties
-│ ├─zookeeper.properties ZooKeeper config properties
-│ ├─master.properties master-service config properties
-│ ├─worker.properties worker-service config properties
-│ ├─quartz.properties quartz config properties
-│ ├─common.properties common-service [storage] config properties
-│ ├─alert.properties alert-service config properties
-│ ├─config environment variables config directory
-│ ├─install_config.conf DS environment variables configuration script [install or start DS]
-│ ├─env load environment variables configs script directory
-│ ├─dolphinscheduler_env.sh load environment variables configs [eg: JAVA_HOME,HADOOP_HOME, HIVE_HOME ...]
-│ ├─org mybatis mapper files directory
-│ ├─i18n i18n configs directory
-│ ├─logback-api.xml API-service log config
-│ ├─logback-master.xml master-service log config
-│ ├─logback-worker.xml worker-service log config
-│ ├─logback-alert.xml alert-service log config
-├─sql .sql files to create or upgrade DS metadata
-│ ├─create create SQL scripts directory
-│ ├─upgrade upgrade SQL scripts directory
-│ ├─dolphinscheduler_postgre.sql PostgreSQL database init script
-│ ├─dolphinscheduler_mysql.sql MySQL database init script
-│ ├─soft_version current DS version-id file
-├─script DS services deployment, database create or upgrade scripts directory
-│ ├─create-dolphinscheduler.sh DS database init script
-│ ├─upgrade-dolphinscheduler.sh DS database upgrade script
-│ ├─monitor-server.sh DS monitor-server start script
-│ ├─scp-hosts.sh transfer installation files script
-│ ├─remove-zk-node.sh cleanup ZooKeeper caches script
-├─ui front-end web resources directory
-├─lib DS .jar dependencies directory
-├─install.sh auto-setup DS services script
+├── LICENSE
+│
+├── NOTICE
+│
+├── licenses directory of licenses
+│
+├── bin directory of DS application commands, configrations scripts
+│ ├── dolphinscheduler-daemon.sh script to start or shut down DS application
+│ ├── env directory of scripts to load environment variables
+│ │ ├── dolphinscheduler_env.sh script to load environment variables [eg: JAVA_HOME,HADOOP_HOME, HIVE_HOME ...]
+│ │ └── install_env.sh script to load environment variables for DS installation
+│ ├── install.sh script to auto-setup DS services
Review Comment:
```suggestion
│ ├── install.sh script to auto-setup DS services, use when you deploy with psuedo-cluster mode or cluster mode
```
##########
docs/docs/en/architecture/configuration.md:
##########
@@ -15,44 +15,87 @@ This document only describes DolphinScheduler configurations and other topics ar
[Note: the DolphinScheduler (hereinafter called the ‘DS’) .]
```
-├─bin DS application commands directory
-│ ├─dolphinscheduler-daemon.sh startup or shutdown DS application
-│ ├─start-all.sh startup all DS services with configurations
-│ ├─stop-all.sh shutdown all DS services with configurations
-├─conf configurations directory
-│ ├─application-api.properties API-service config properties
-│ ├─datasource.properties datasource config properties
-│ ├─zookeeper.properties ZooKeeper config properties
-│ ├─master.properties master-service config properties
-│ ├─worker.properties worker-service config properties
-│ ├─quartz.properties quartz config properties
-│ ├─common.properties common-service [storage] config properties
-│ ├─alert.properties alert-service config properties
-│ ├─config environment variables config directory
-│ ├─install_config.conf DS environment variables configuration script [install or start DS]
-│ ├─env load environment variables configs script directory
-│ ├─dolphinscheduler_env.sh load environment variables configs [eg: JAVA_HOME,HADOOP_HOME, HIVE_HOME ...]
-│ ├─org mybatis mapper files directory
-│ ├─i18n i18n configs directory
-│ ├─logback-api.xml API-service log config
-│ ├─logback-master.xml master-service log config
-│ ├─logback-worker.xml worker-service log config
-│ ├─logback-alert.xml alert-service log config
-├─sql .sql files to create or upgrade DS metadata
-│ ├─create create SQL scripts directory
-│ ├─upgrade upgrade SQL scripts directory
-│ ├─dolphinscheduler_postgre.sql PostgreSQL database init script
-│ ├─dolphinscheduler_mysql.sql MySQL database init script
-│ ├─soft_version current DS version-id file
-├─script DS services deployment, database create or upgrade scripts directory
-│ ├─create-dolphinscheduler.sh DS database init script
-│ ├─upgrade-dolphinscheduler.sh DS database upgrade script
-│ ├─monitor-server.sh DS monitor-server start script
-│ ├─scp-hosts.sh transfer installation files script
-│ ├─remove-zk-node.sh cleanup ZooKeeper caches script
-├─ui front-end web resources directory
-├─lib DS .jar dependencies directory
-├─install.sh auto-setup DS services script
+├── LICENSE
+│
+├── NOTICE
+│
+├── licenses directory of licenses
+│
+├── bin directory of DS application commands, configrations scripts
+│ ├── dolphinscheduler-daemon.sh script to start or shut down DS application
+│ ├── env directory of scripts to load environment variables
+│ │ ├── dolphinscheduler_env.sh script to load environment variables [eg: JAVA_HOME,HADOOP_HOME, HIVE_HOME ...]
+│ │ └── install_env.sh script to load environment variables for DS installation
+│ ├── install.sh script to auto-setup DS services
+│ ├── remove-zk-node.sh script to cleanup ZooKeeper caches
+│ ├── scp-hosts.sh script to copy installation files to target hosts
+│ ├── start-all.sh script to start all DS services
Review Comment:
```suggestion
│ ├── start-all.sh script to start all DS services, use when you deploy with pseudo-cluster mode or cluster mode
```
##########
docs/docs/en/architecture/configuration.md:
##########
@@ -15,44 +15,87 @@ This document only describes DolphinScheduler configurations and other topics ar
[Note: the DolphinScheduler (hereinafter called the ‘DS’) .]
```
-├─bin DS application commands directory
-│ ├─dolphinscheduler-daemon.sh startup or shutdown DS application
-│ ├─start-all.sh startup all DS services with configurations
-│ ├─stop-all.sh shutdown all DS services with configurations
-├─conf configurations directory
-│ ├─application-api.properties API-service config properties
-│ ├─datasource.properties datasource config properties
-│ ├─zookeeper.properties ZooKeeper config properties
-│ ├─master.properties master-service config properties
-│ ├─worker.properties worker-service config properties
-│ ├─quartz.properties quartz config properties
-│ ├─common.properties common-service [storage] config properties
-│ ├─alert.properties alert-service config properties
-│ ├─config environment variables config directory
-│ ├─install_config.conf DS environment variables configuration script [install or start DS]
-│ ├─env load environment variables configs script directory
-│ ├─dolphinscheduler_env.sh load environment variables configs [eg: JAVA_HOME,HADOOP_HOME, HIVE_HOME ...]
-│ ├─org mybatis mapper files directory
-│ ├─i18n i18n configs directory
-│ ├─logback-api.xml API-service log config
-│ ├─logback-master.xml master-service log config
-│ ├─logback-worker.xml worker-service log config
-│ ├─logback-alert.xml alert-service log config
-├─sql .sql files to create or upgrade DS metadata
-│ ├─create create SQL scripts directory
-│ ├─upgrade upgrade SQL scripts directory
-│ ├─dolphinscheduler_postgre.sql PostgreSQL database init script
-│ ├─dolphinscheduler_mysql.sql MySQL database init script
-│ ├─soft_version current DS version-id file
-├─script DS services deployment, database create or upgrade scripts directory
-│ ├─create-dolphinscheduler.sh DS database init script
-│ ├─upgrade-dolphinscheduler.sh DS database upgrade script
-│ ├─monitor-server.sh DS monitor-server start script
-│ ├─scp-hosts.sh transfer installation files script
-│ ├─remove-zk-node.sh cleanup ZooKeeper caches script
-├─ui front-end web resources directory
-├─lib DS .jar dependencies directory
-├─install.sh auto-setup DS services script
+├── LICENSE
+│
+├── NOTICE
+│
+├── licenses directory of licenses
+│
+├── bin directory of DS application commands, configrations scripts
+│ ├── dolphinscheduler-daemon.sh script to start or shut down DS application
+│ ├── env directory of scripts to load environment variables
+│ │ ├── dolphinscheduler_env.sh script to load environment variables [eg: JAVA_HOME,HADOOP_HOME, HIVE_HOME ...]
+│ │ └── install_env.sh script to load environment variables for DS installation
+│ ├── install.sh script to auto-setup DS services
+│ ├── remove-zk-node.sh script to cleanup ZooKeeper caches
+│ ├── scp-hosts.sh script to copy installation files to target hosts
+│ ├── start-all.sh script to start all DS services
+│ ├── status-all.sh script to check the status of all DS services
+│ └── stop-all.sh script to shut down all DS services
+│
+├── alert-server directory of DS alert-server commands, configrations scripts and libs
+│ ├── bin
+│ │ └── start.sh script to start DS alert-server
+│ ├── conf
+│ │ ├── application.yaml configurations of alert-server
+│ │ ├── common.properties configurations of common-service like storage, credentials, etc.
+│ │ ├── dolphinscheduler_env.sh script to load environment variables for alert-server
+│ │ └── logback-spring.xml configurations of alert-service log
+│ └── libs directory of alert-server libs
+│
+├── api-server directory of DS api-server commands, configrations scripts and libs
+│ ├── bin
+│ │ └── start.sh script to start DS api-server
+│ ├── conf
+│ │ ├── application.yaml configurations of api-server
+│ │ ├── common.properties configurations of common-service like storage, credentials, etc.
+│ │ ├── dolphinscheduler_env.sh script to load environment variables for api-server
+│ │ └── logback-spring.xml configurations of api-service log
+│ ├── libs directory of api-server libs
+│ └── ui
+│
+├── master-server directory of DS master-server commands, configrations scripts and libs
+│ ├── bin
+│ │ └── start.sh script to start DS master-server
+│ ├── conf
+│ │ ├── application.yaml configurations of master-server
+│ │ ├── common.properties configurations of common-service like storage, credentials, etc.
+│ │ ├── dolphinscheduler_env.sh script to load environment variables for master-server
+│ │ └── logback-spring.xml configurations of master-service log
+│ └── libs directory of master-server libs
+│
+├── standalone-server directory of DS standalone-server commands, configrations scripts and libs
Review Comment:
indentation
##########
docs/docs/en/architecture/configuration.md:
##########
@@ -15,44 +15,87 @@ This document only describes DolphinScheduler configurations and other topics ar
[Note: the DolphinScheduler (hereinafter called the ‘DS’) .]
```
-├─bin DS application commands directory
-│ ├─dolphinscheduler-daemon.sh startup or shutdown DS application
-│ ├─start-all.sh startup all DS services with configurations
-│ ├─stop-all.sh shutdown all DS services with configurations
-├─conf configurations directory
-│ ├─application-api.properties API-service config properties
-│ ├─datasource.properties datasource config properties
-│ ├─zookeeper.properties ZooKeeper config properties
-│ ├─master.properties master-service config properties
-│ ├─worker.properties worker-service config properties
-│ ├─quartz.properties quartz config properties
-│ ├─common.properties common-service [storage] config properties
-│ ├─alert.properties alert-service config properties
-│ ├─config environment variables config directory
-│ ├─install_config.conf DS environment variables configuration script [install or start DS]
-│ ├─env load environment variables configs script directory
-│ ├─dolphinscheduler_env.sh load environment variables configs [eg: JAVA_HOME,HADOOP_HOME, HIVE_HOME ...]
-│ ├─org mybatis mapper files directory
-│ ├─i18n i18n configs directory
-│ ├─logback-api.xml API-service log config
-│ ├─logback-master.xml master-service log config
-│ ├─logback-worker.xml worker-service log config
-│ ├─logback-alert.xml alert-service log config
-├─sql .sql files to create or upgrade DS metadata
-│ ├─create create SQL scripts directory
-│ ├─upgrade upgrade SQL scripts directory
-│ ├─dolphinscheduler_postgre.sql PostgreSQL database init script
-│ ├─dolphinscheduler_mysql.sql MySQL database init script
-│ ├─soft_version current DS version-id file
-├─script DS services deployment, database create or upgrade scripts directory
-│ ├─create-dolphinscheduler.sh DS database init script
-│ ├─upgrade-dolphinscheduler.sh DS database upgrade script
-│ ├─monitor-server.sh DS monitor-server start script
-│ ├─scp-hosts.sh transfer installation files script
-│ ├─remove-zk-node.sh cleanup ZooKeeper caches script
-├─ui front-end web resources directory
-├─lib DS .jar dependencies directory
-├─install.sh auto-setup DS services script
+├── LICENSE
+│
+├── NOTICE
+│
+├── licenses directory of licenses
+│
+├── bin directory of DS application commands, configrations scripts
+│ ├── dolphinscheduler-daemon.sh script to start or shut down DS application
+│ ├── env directory of scripts to load environment variables
+│ │ ├── dolphinscheduler_env.sh script to load environment variables [eg: JAVA_HOME,HADOOP_HOME, HIVE_HOME ...]
+│ │ └── install_env.sh script to load environment variables for DS installation
+│ ├── install.sh script to auto-setup DS services
+│ ├── remove-zk-node.sh script to cleanup ZooKeeper caches
+│ ├── scp-hosts.sh script to copy installation files to target hosts
+│ ├── start-all.sh script to start all DS services
+│ ├── status-all.sh script to check the status of all DS services
Review Comment:
```suggestion
│ ├── status-all.sh script to check the status of all DS services, use when you deploy with pseudo-cluster mode or cluster mode
```
##########
docs/docs/en/architecture/configuration.md:
##########
@@ -15,44 +15,87 @@ This document only describes DolphinScheduler configurations and other topics ar
[Note: the DolphinScheduler (hereinafter called the ‘DS’) .]
```
-├─bin DS application commands directory
-│ ├─dolphinscheduler-daemon.sh startup or shutdown DS application
-│ ├─start-all.sh startup all DS services with configurations
-│ ├─stop-all.sh shutdown all DS services with configurations
-├─conf configurations directory
-│ ├─application-api.properties API-service config properties
-│ ├─datasource.properties datasource config properties
-│ ├─zookeeper.properties ZooKeeper config properties
-│ ├─master.properties master-service config properties
-│ ├─worker.properties worker-service config properties
-│ ├─quartz.properties quartz config properties
-│ ├─common.properties common-service [storage] config properties
-│ ├─alert.properties alert-service config properties
-│ ├─config environment variables config directory
-│ ├─install_config.conf DS environment variables configuration script [install or start DS]
-│ ├─env load environment variables configs script directory
-│ ├─dolphinscheduler_env.sh load environment variables configs [eg: JAVA_HOME,HADOOP_HOME, HIVE_HOME ...]
-│ ├─org mybatis mapper files directory
-│ ├─i18n i18n configs directory
-│ ├─logback-api.xml API-service log config
-│ ├─logback-master.xml master-service log config
-│ ├─logback-worker.xml worker-service log config
-│ ├─logback-alert.xml alert-service log config
-├─sql .sql files to create or upgrade DS metadata
-│ ├─create create SQL scripts directory
-│ ├─upgrade upgrade SQL scripts directory
-│ ├─dolphinscheduler_postgre.sql PostgreSQL database init script
-│ ├─dolphinscheduler_mysql.sql MySQL database init script
-│ ├─soft_version current DS version-id file
-├─script DS services deployment, database create or upgrade scripts directory
-│ ├─create-dolphinscheduler.sh DS database init script
-│ ├─upgrade-dolphinscheduler.sh DS database upgrade script
-│ ├─monitor-server.sh DS monitor-server start script
-│ ├─scp-hosts.sh transfer installation files script
-│ ├─remove-zk-node.sh cleanup ZooKeeper caches script
-├─ui front-end web resources directory
-├─lib DS .jar dependencies directory
-├─install.sh auto-setup DS services script
+├── LICENSE
+│
+├── NOTICE
+│
+├── licenses directory of licenses
+│
+├── bin directory of DS application commands, configrations scripts
+│ ├── dolphinscheduler-daemon.sh script to start or shut down DS application
+│ ├── env directory of scripts to load environment variables
+│ │ ├── dolphinscheduler_env.sh script to load environment variables [eg: JAVA_HOME,HADOOP_HOME, HIVE_HOME ...]
+│ │ └── install_env.sh script to load environment variables for DS installation
+│ ├── install.sh script to auto-setup DS services
+│ ├── remove-zk-node.sh script to cleanup ZooKeeper caches
+│ ├── scp-hosts.sh script to copy installation files to target hosts
+│ ├── start-all.sh script to start all DS services
+│ ├── status-all.sh script to check the status of all DS services
+│ └── stop-all.sh script to shut down all DS services
+│
+├── alert-server directory of DS alert-server commands, configrations scripts and libs
+│ ├── bin
+│ │ └── start.sh script to start DS alert-server
+│ ├── conf
+│ │ ├── application.yaml configurations of alert-server
+│ │ ├── common.properties configurations of common-service like storage, credentials, etc.
+│ │ ├── dolphinscheduler_env.sh script to load environment variables for alert-server
+│ │ └── logback-spring.xml configurations of alert-service log
+│ └── libs directory of alert-server libs
+│
+├── api-server directory of DS api-server commands, configrations scripts and libs
+│ ├── bin
+│ │ └── start.sh script to start DS api-server
+│ ├── conf
+│ │ ├── application.yaml configurations of api-server
+│ │ ├── common.properties configurations of common-service like storage, credentials, etc.
+│ │ ├── dolphinscheduler_env.sh script to load environment variables for api-server
+│ │ └── logback-spring.xml configurations of api-service log
+│ ├── libs directory of api-server libs
+│ └── ui
+│
+├── master-server directory of DS master-server commands, configrations scripts and libs
+│ ├── bin
+│ │ └── start.sh script to start DS master-server
+│ ├── conf
+│ │ ├── application.yaml configurations of master-server
+│ │ ├── common.properties configurations of common-service like storage, credentials, etc.
+│ │ ├── dolphinscheduler_env.sh script to load environment variables for master-server
+│ │ └── logback-spring.xml configurations of master-service log
+│ └── libs directory of master-server libs
+│
+├── standalone-server directory of DS standalone-server commands, configrations scripts and libs
+│ ├── bin
+│ │ └── start.sh script to start DS standalone-server
+│ ├── conf
+│ │ ├── application.yaml configurations of standalone-server
+│ │ ├── common.properties configurations of common-service like storage, credentials, etc.
+│ │ ├── dolphinscheduler_env.sh script to load environment variables for standalone-server
+│ │ ├── logback-spring.xml configurations of standalone-service log
+│ │ └── sql .sql files to create or upgrade DS metadata
+│ ├── libs directory of standalone-server libs
+│ └── ui
+│
+├── tools directory of DS metadata tools commands, configrations scripts and libs
Review Comment:
indentation here too
--
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] zhongjiajie commented on a diff in pull request #10107: [Bug][Doc]Update project directory structure in docs
Posted by GitBox <gi...@apache.org>.
zhongjiajie commented on code in PR #10107:
URL: https://github.com/apache/dolphinscheduler/pull/10107#discussion_r876666718
##########
docs/docs/en/architecture/configuration.md:
##########
@@ -15,44 +15,87 @@ This document only describes DolphinScheduler configurations and other topics ar
[Note: the DolphinScheduler (hereinafter called the ‘DS’) .]
```
-├─bin DS application commands directory
-│ ├─dolphinscheduler-daemon.sh startup or shutdown DS application
-│ ├─start-all.sh startup all DS services with configurations
-│ ├─stop-all.sh shutdown all DS services with configurations
-├─conf configurations directory
-│ ├─application-api.properties API-service config properties
-│ ├─datasource.properties datasource config properties
-│ ├─zookeeper.properties ZooKeeper config properties
-│ ├─master.properties master-service config properties
-│ ├─worker.properties worker-service config properties
-│ ├─quartz.properties quartz config properties
-│ ├─common.properties common-service [storage] config properties
-│ ├─alert.properties alert-service config properties
-│ ├─config environment variables config directory
-│ ├─install_config.conf DS environment variables configuration script [install or start DS]
-│ ├─env load environment variables configs script directory
-│ ├─dolphinscheduler_env.sh load environment variables configs [eg: JAVA_HOME,HADOOP_HOME, HIVE_HOME ...]
-│ ├─org mybatis mapper files directory
-│ ├─i18n i18n configs directory
-│ ├─logback-api.xml API-service log config
-│ ├─logback-master.xml master-service log config
-│ ├─logback-worker.xml worker-service log config
-│ ├─logback-alert.xml alert-service log config
-├─sql .sql files to create or upgrade DS metadata
-│ ├─create create SQL scripts directory
-│ ├─upgrade upgrade SQL scripts directory
-│ ├─dolphinscheduler_postgre.sql PostgreSQL database init script
-│ ├─dolphinscheduler_mysql.sql MySQL database init script
-│ ├─soft_version current DS version-id file
-├─script DS services deployment, database create or upgrade scripts directory
-│ ├─create-dolphinscheduler.sh DS database init script
-│ ├─upgrade-dolphinscheduler.sh DS database upgrade script
-│ ├─monitor-server.sh DS monitor-server start script
-│ ├─scp-hosts.sh transfer installation files script
-│ ├─remove-zk-node.sh cleanup ZooKeeper caches script
-├─ui front-end web resources directory
-├─lib DS .jar dependencies directory
-├─install.sh auto-setup DS services script
+├── LICENSE
+│
+├── NOTICE
+│
+├── licenses directory of licenses
+│
+├── bin directory of DS application commands, configrations scripts
Review Comment:
I never found it before, we could use it only if we have this sentence in the beginning of our document, mean in https://dolphinscheduler.apache.org/zh-cn/docs/dev/user_doc/about/introduction.html
--
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] EricGao888 commented on pull request #10107: [Bug][Doc]Update project directory structure in docs
Posted by GitBox <gi...@apache.org>.
EricGao888 commented on PR #10107:
URL: https://github.com/apache/dolphinscheduler/pull/10107#issuecomment-1132765125
> @EricGao888 Do you have time to complete this PR recently? we are going to release 3.0.0-beta-1 next week
@zhongjiajie Comments resolved, but need to double check the description for ui folders under standalone-server and api-server. Will update the Chinese doc in next commit if it looks good to you.
--
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] zhongjiajie commented on pull request #10107: [Bug][Doc]Update project directory structure in docs
Posted by GitBox <gi...@apache.org>.
zhongjiajie commented on PR #10107:
URL: https://github.com/apache/dolphinscheduler/pull/10107#issuecomment-1133608887
> > @EricGao888 Do you have time to complete this PR recently? we are going to release 3.0.0-beta-1 next week
>
> @zhongjiajie Comments resolved, but need to double check the description for ui folders under standalone-server and api-server. Will update the Chinese doc in next commit if it looks good to you.
LGTM, please also change the ZH docs, thanks
--
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