[Optimize][doc]doc optimize (DataLinkDC#1515)

* doc optimize * doc optimize
dufeng1010 · Jan 6, 2023 · a3c3df2 · a3c3df2
1 parent 23e8d5a
commit a3c3df2
Show file tree

Hide file tree

Showing 54 changed files with 1,508 additions and 2,382 deletions.
diff --git a/build.cmd b/build.cmd
@@ -23,7 +23,7 @@ echo "Clean Project ..."
 call ./mvnw.cmd clean -f pom.xml
 
 echo "Build Project ..."
-call ./mvnw.cmd package -f pom.xml -D"maven.test.skip=true"
+call ./mvnw.cmd package -f pom.xml -D"maven.test.skip=true"  -P aliyun,prod,scala-2.12,web,flink-1.14
 
 :exit
 pause
diff --git a/build.sh b/build.sh
@@ -14,4 +14,4 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-./mvnw clean package -Dmaven.test.skip=true
+./mvnw clean package -Dmaven.test.skip=true -P aliyun,prod,scala-2.12,web,flink-1.14
diff --git a/docs/docs/deploy_guide/build.md → docs/docs/deploy_guide/compile.mdx b/docs/docs/deploy_guide/build.md → docs/docs/deploy_guide/compile.mdx
@@ -4,42 +4,46 @@ id: compiler
 title: 编译
 ---
 
-
-
 ## 环境准备
 
-| **环境** | **版本**  | 备注                              |
-| -------- | --------- | --------------------------------- |
-| npm      | 7.19.0    |                                   |
-| node.js  | 14.19.0   |                                   |
-| jdk      | 1.8.0_201 |                                   |
-| maven    | 3.6.3     |                                   |
-| lombok   | 1.18.16   | 如果在idea编译，需要自行安装 插件 |
-| mysql    | 5.7+      |                                   |
+| **环境**  | **版本**    | 备注                  |
+|---------|-----------|---------------------|
+| npm     | 7.19.0    |                     |
+| node.js | 14.19.0   |                     |
+| jdk     | 1.8.0_201 |                     |
+| maven   | 3.6.3     |                     |
+| lombok  | 1.18.24   | 如果在idea编译，需要自行安装 插件 |
+| mysql   | 5.7+      |                     |
 
 ## NodeJS 安装部署
 
-### Windows 版本
 
-[下载地址]( <https://registry.npmmirror.com/-/binary/node/v14.19.0/node-v14.19.0-x64.msi>)
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
+
+<Tabs groupId="operating-systems">
+<TabItem value="win" label="Windows" default>
+
+[下载地址]( https://registry.npmmirror.com/-/binary/node/v14.19.0/node-v14.19.0-x64.msi)
 
 下载完成后，双击傻瓜式安装即可
 
 由于Dinky编译NPM最低版本为7.19.0，因此需要把NPM版本升级到7.19.0。具体操作如下
 
-```
+```bash
 npm install -g npm@7.19.0
 ```
 
-### Linux 版本
+</TabItem>
+<TabItem value="linux" label="Linux">
 
 [下载地址](https://nodejs.org/download/release/v14.19.1/node-v14.19.1-linux-x64.tar.gz)
 
 下载完成后，安装配置即可，操作如下：
 
-```
+```bash
 tar xf node-v14.19.0.tar.gz -C /opt/module/
-vim /etc/profile  
+vim /etc/profile
 export NODEJS_HOME=/opt/module/node-v14.19.0
 export PATH=$NODEJS_HOME/bin:$PATH
 #保存退出
@@ -48,49 +52,62 @@ source /etc/profile #刷新环境变量
 
 由于Dinky编译NPM最低版本为7.19.0，因此需要把NPM版本升级到7.19.0。具体操作如下：
 
-```
+```bash
 npm install -g npm@7.19.0
 ```
 
+</TabItem>
+<TabItem value="mac" label="MacOS">
+
+[下载地址]( https://registry.npmmirror.com/-/binary/node/v14.19.0/node-v14.19.0.pkg)
+
+下载完成后，双击傻瓜式安装即可
+
+</TabItem>
+</Tabs>
+
+---
 ## MySQL 部署
 
 MySQL版本选择5.7+
 
-### Windows 版本
+<Tabs groupId="operating-systems">
+<TabItem value="win" label="Windows" default>
 
-[下载地址](<https://dev.mysql.com/downloads/file/?id=510038>)
+[下载地址](https://dev.mysql.com/downloads/file/?id=510038)
 
 下载完成后，双击傻瓜式安装即可
 
-### Linux 版本
+</TabItem>
+<TabItem value="linux" label="Linux">
 
 [下载地址](http://dev.mysql.com/get/mysql57-community-release-el7-10.noarch.rpm)
 
 下载完成后，安装配置即可，操作如下：
 
-```
+```bash
 #如果没有wget命令
-    yum install wget
+yum install wget
 #下载mysql 5.7
-    wget  http://dev.mysql.com/get/mysql57-community-release-el7-11.noarch.rpm
+wget  http://dev.mysql.com/get/mysql57-community-release-el7-11.noarch.rpm
 #安装yum repository
-    yum -y install mysql57-community-release-el7-11.noarch.rpm
+yum -y install mysql57-community-release-el7-11.noarch.rpm
 #在线安装
-    yum -y install mysql-community-server
+yum -y install mysql-community-server
 #修改配置文件
-    vi /etc/my.cnf
-    skip-grant-tables     #末尾添加这句话，这时候登入mysql就不需要密码
+vi /etc/my.cnf
+skip-grant-tables     #末尾添加这句话，这时候登入mysql就不需要密码
 #开启mysql服务
-    service mysqld start
+service mysqld start
 #空密码登录mysql
-    mysql -u root -p
+mysql -u root -p
 #设置root密码
-    flush privileges;
-    set password for root@localhost = password('123456');
+flush privileges;
+set password for root@localhost = password('123456');
 #恢复mysql配置
-    service mysqld stop #停止mysql服务
-    vi /etc/my.cnf     #修改配置文件
-    # skip-grant-tables # 注释掉这句话
+service mysqld stop #停止mysql服务
+vi /etc/my.cnf     #修改配置文件
+# skip-grant-tables # 注释掉这句话
 service mysqld start # 启动mysql服务
 #设置开机自启动
 systemctl enable mysqld
@@ -130,11 +147,19 @@ SHOW VARIABLES LIKE 'collation_%'; 排序规则
 #改变的是新建的表
 ```
 
+</TabItem>
+<TabItem value="mac" label="MacOS">
+
+</TabItem>
+</Tabs>
+
+---
 ## Maven 安装部署
 
-### Windows 版本
+<Tabs groupId="operating-systems">
+<TabItem value="win" label="Windows" default>
 
-[下载地址](<https://dlcdn.apache.org/maven/maven-3/3.6.3/binaries/apache-maven-3.6.3-bin.zip>)
+[下载地址](https://dlcdn.apache.org/maven/maven-3/3.6.3/binaries/apache-maven-3.6.3-bin.zip)
 
 下载完成后后，解压到对应目录
 
@@ -145,112 +170,119 @@ SHOW VARIABLES LIKE 'collation_%'; 排序规则
 完成，以验证它，执行 mvn –v 在命令提示符
 ```
 
-### Linux 版本
+</TabItem>
+<TabItem value="linux" label="Linux">
 
-[下载地址](<https://dlcdn.apache.org/maven/maven-3/3.6.3/binaries/apache-maven-3.6.3-bin.tar.gz>)
+[下载地址](https://dlcdn.apache.org/maven/maven-3/3.6.3/binaries/apache-maven-3.6.3-bin.tar.gz)
 
 下载完成后后，解压到对应目录
 
-解压安装 
+解压安装
 
-```
+```bash
 tar xf apache-maven-3.6.3-bin.tar.gz -C /opt/module/
 cd /opt/module/
 mv apache-maven-3.6.3-bin maven-3.6.3
 
 #添加环境变量
-vim /etc/profile  
+vim /etc/profile
 export MAVEN_HOME=/opt/module/maven-3.6.3
 export PATH=$MAVEN_HOME/bin:$PATH
 
 #保存退出，刷新环境变量
-source /etc/profile 
+source /etc/profile
 ```
 
 以上环境准备就绪后，接下来就可以开始Dinky的编译。
 
-## Dinky 编译
+</TabItem>
+<TabItem value="mac" label="MacOS">
 
-### Windows 编译
+</TabItem>
+</Tabs>
 
-#### 直接编译
+---
+## Dinky 编译
 
-如果在window直接编译，首先将源码包解压到相应目录下，其次切换到Dinky根目录,编译命令如下：
+### Maven 编译
+将源码包解压到相应目录下，其次切换到Dinky根目录,编译命令如下：
 
-```
+```bash
 # 默认版本：scala-2.12 , flink-1.14
-mvn clean install -Dmaven.test.skip=true
+mvn clean install -Dmaven.test.skip=true -P aliyun,prod,scala-2.12,web,fast,flink-1.14
 
 # 如若修改版本，按以下指定即可。flink可支持多版本(1.11-1.16)
-mvn clean install -Dmaven.test.skip=true -P aliyun,nexus,prod,scala-2.11,web,flink-1.14
+mvn clean install -Dmaven.test.skip=true -P aliyun,prod,scala-2.12,web,fast,flink-1.14,flink-1.15
+
+# 如若需要编译全部flink版本，推荐指令如下(会下载flink11-16全部的依赖，谨慎使用)
+mvn clean install -Dmaven.test.skip=true -P aliyun,prod,scala-2.12,web,fast,all
 ```
 
-切换到 Dinky 根目录下得 build 文件夹下，即可出现编译后的安装包
+最后切换到 Dinky 根目录下得 build 文件夹下，即可出现编译后的安装包
 
-#### IDEA 编译
+<Tabs groupId="operating-systems">
+<TabItem value="idea" label="IDEA" default>
 
 ```
-创建 远程克隆项目 
+创建 远程克隆项目
 maven ->> dlink->> 配置文件->> 生命周期->> 跳过测试 ->> 双击install
 打包完成后 安装包见项目根下  build 文件夹下
 ```
+
+:::tip
+
+具体 `profile` 选择请参考如上
+
 ![local_debug_maven_profile_intro.png](http://www.aiwenmo.com/dinky/docs/zh-CN/developer_guide/local_debug/local_debug_maven_profile_intro.png)
 
-配置
 说明：如果要对 Dinky 做二次开发，详见开发者指南中的[本地调试](../developer_guide/local_debug)
+:::
 
-### Linux 编译
+</TabItem>
+<TabItem value="linux" label="Linux">
 
-```
+```bash
 yum -y install git
 git clone https://github.com/DataLinkDC/dlink.git
-cd dlink 
-mvn clean install -Dmaven.test.skip=true
+cd dlink
+# 这一步指令具体使用方法，参考上面
+mvn clean install -Dmaven.test.skip=true -P aliyun,prod,scala-2.12,web,fast,flink-1.14
 ```
->如若修改版本，按以下指定即可。flink可支持多版本(1.11-1.16)
-> 
-> `mvn clean install -Dmaven.test.skip=true -P aliyun,nexus,prod,scala-2.11,web,flink-1.14`
 
 切换到 Dinky 根目录下得 build 文件夹下，即可出现编译后的安装包。
 
----
-### 前后端分离编译
-#### 前端编译
+</TabItem>
+<TabItem value="leave" label="前后端分离">
+
+* 前端编译
 在 dlink-web 目录下，执行 ：
-```shell
+```bash
 npm install --force
 npm run build
 ```
 编译后的产物在 `dlink-web/dist` 下面，如需部署，请查看相关部署教程。[nginx中配置-dinky](./deploy#nginx 中配置-dinky可选)
 
-#### 后端编译
+* 后端编译
 编译maven的时候，移除web profile即可。在-P 后面加: `!web`,如：
-
-`mvn clean install -Dmaven.test.skip=true -P !web,aliyun,nexus,prod,scala-2.11,flink-1.14
-`
-
-
----
-
-### 构建 Docker 镜像
-基于Dinky每次发布的[ Release ](http://www.dlink.top/download/download)构建：
-1. 将`Dockerfile`、`docker-entrypoint.sh`文件拷贝至release包解压目录
-2. 执行下述构建与推送命令，根据需要推送至公共或私有仓库
 ```bash
-docker build --tag ylyue/dinky:0.6.4-flink1.15 .
-docker push ylyue/dinky:0.6.4-flink1.15
-docker login --username=xxxxxxxx registry.cn-beijing.aliyuncs.com
-docker tag ylyue/dinky:0.6.4-flink1.15 registry.cn-beijing.aliyuncs.com/yue-open/dinky:0.6.4-flink1.15
-docker push registry.cn-beijing.aliyuncs.com/yue-open/dinky:0.6.4-flink1.15
+    mvn clean install -Dmaven.test.skip=true -P !web,aliyun,prod,scala-2.12,fast,flink-1.14
 ```
 
-[👉已构建的 DockerHub 仓库](https://hub.docker.com/r/ylyue/dinky)
-
+</TabItem>
+</Tabs>
 
+---
 
+## Docker 快速体验
+[点我跳转](../get_started/docker_deploy)
 
 
+----
+:::info
 以上就是 Dinky 源码编译的详细步骤，Dinky 如何安装部署，请查看下一章节[部署](./deploy)
+:::
+
+