feat: 从docs仓库迁移到本仓库

LDP集中式安装部署说明.md

+## LDP集中式安装部署说明
+
+[TOC]
+
+    此文档说明在单服务器下，集中式安装部署所有LDP服务；LDP依赖 mysql,redis等中间件服务，建议使用其它服务器独立安装部署。
+
+## 服务器参数  
+Server OS：CentOS Linux release 7.5+  
+Mem：16G  
+Core：8核  
+
+## 运行环境准备
+
+#### JRE 1.8+ (服务器版)
+
+  安装包已提供 jre-8u251-linux-x64.tar.gz 需自行解压配置环境，过程略。
+
+#### mysql
+
+安装
+```shell
+## 配置源
+vi /etc/yum.repos.d/mysql57-community.repo 
+[mysql57-community]
+name=MySQL 5.7 Community Server
+baseurl=http://repo.mysql.com/yum/mysql-5.7-community/el/7/$basearch/
+enabled=1
+gpgcheck=0
+gpgkey=file:///etc/pki/rpm-gpg/RPM-GPG-KEY-mysql
+## 安装
+yum repolist enabled | grep mysql
+sudo yum install mysql-community-server
+```
+
+配置
+```shell
+## 加入大小写忽略配置
+vi  /etc/my.cnf
+lower_case_table_names=1
+```
+服务管理
+
+```shell
+## 启动，停止，状态
+systemctl start mysqld
+systemctl stop mysqld
+systemctl status mysqld
+```
+
+#### redis 
+
+安装
+
+```shell
+sudo yum install redis
+```
+
+配置
+
+```shell
+##配置文件，修改配置远程连接,端口，密码，如下
+vi /etc/redis.conf
+# bind 127.0.0.1 
+port 7268
+requirepass cacheForldp2020
+
+```
+服务管理
+
+```shell
+## 查看状态，启动，停止
+sudo systemctl status redis
+sudo systemctl start redis
+sudo systemctl stop redis
+```
+
+#### nginx 1.12+ 
+
+下载
+```shell
+wget http://downloads.sourceforge.net/project/pcre/pcre/8.35/pcre-8.35.tar.gz
+
+wget http://nginx.org/download/nginx-1.13.6.tar.gz
+
+```
+
+安装
+
+```shell
+yum -y install make zlib zlib-devel gcc-c++ libtool openssl openssl-devel
+
+tar -xvf pcre-8.35.tar.gz -C /usr/local
+cd /usr/local/pcre-8.35/
+./configure
+make && make install
+
+tar -xvf nginx-1.13.6.tar.gz -c /usr/local
+cd nginx-1.13.6
+./configure --prefix=/usr/local/nginx --with-http_stub_status_module --with-http_ssl_module --with-pcre=/usr/local/pcre-8.35 
+make && make install
+```
+
+服务管理  
+
+```shell 
+cd /usr/local/nginx/sbin  
+# 启动
+./nginx 
+# 停止 
+./nginx -s stop  
+```
+
+#### nacos 
+
+LDP安装包已集成。
+
+
+## LDP安装说明
+
+
+#### 安装包目录
+```shell
+├── bin
+├── conf
+│   ├── application.yml   #manage服务配置文件
+│   ├── boot.conf         #启动配置文件，nacos地址和spring.profiles.active
+│   ├── logback.xml       #manage服务日志配置文件
+│   └── sinra_ldp_db.sql  #数据库初始化sql文件
+├── extlib
+├── fatjar
+│   ├── base-startup-1.0-SNAPSHOT.jar  #基础服务jar包
+│   ├── job-startup-1.0.38.jar         #job 服务jar包
+│   ├── ldp-generator-1.0-SNAPSHOT.jar #自动生成代码服务包
+│   ├── mcs-startup-1.0.38.jar         #mcs服务jar包
+│   ├── service-gateway-1.0.38.jar     #网关服务jar包
+│   └── uaa-startup-1.0.38.jar         #统一认证uaa服务jar包
+├── jre-8u251-linux-x64.tar.gz   #jre压缩包
+├── lib          #服务依赖jar包目录
+├── logs         #日志目录
+├── nacos        #naocs目录
+│   ├── bin 
+│   ├── conf
+│   ├── data
+│   ├── LICENSE
+│   ├── logs
+│   ├── NOTICE
+│   └── target
+├── tool                  
+│   ├── base-boot.sh      #基础服务启动/关闭脚本
+│   ├── gateway-boot.sh   #网关服务启动/关闭脚本
+│   ├── generator-boot.sh #自动生成代码服务启动/关闭脚本
+│   ├── job-boot.sh       #job服务启动/关闭脚本
+│   ├── ldp-boot.sh       #统一启动关闭脚本，所有ldp服务可以通过此脚本一件启动和关闭
+│   ├── manage-boot.sh    #manage服务启动/关闭脚本
+│   ├── mcs-boot.sh       #mcs服务启动/关闭脚本
+│   └── uaa-boot.sh       #uaa服务启动/关闭脚本
+└── ui
+    └── mcs   #mcs前端资源目录
+```
+
+#### 中间件服务hosts配置
+
+在服务器host配置中加入以下配置，根据实际服务修改相应ip
+
+```shell
+# mysql 数据库服务
+127.0.0.1 mysql-server0
+# redis 服务
+127.0.0.1 redis-server0
+# nacos 服务
+127.0.0.1 nacos-server0
+
+# 网关服务
+127.0.0.1 gateway-server0
+
+```
+
+#### 新建数据库
+
+- 在mysql内创建ldp数据库: sinra_ldp_db ，字符集：utf8mb4
+
+
+####  nacos 启动 & 访问
+
+```shell
+# 启动
+cd nacos/bin
+./startup.sh -m standalone
+ 
+```
+
+访问地址：http://nacos-server0:8018/nacos   
+
+默认用户名/口令： nacos/nacos
+
+
+### nacos在线配置参数
+
+#### 数据库参数配置   
+
+ * 进入nacos配置列表
+	 	![nacos配置列表](imgs/nacos-config-list.png)
+  * 修改base-server-nacos.yml
+     ![base-server-nacos.yml](imgs/base-server-nacos-config-list.png)
+  * 修改如图所示的用户名及密码
+     ![base-server-nacos.yml](imgs/base-server-nacos-config-list-change.png)
+  * 修改后保存即可
+
+#### redis 参数配置   
+
+* 进入nacos配置列表
+	 	![nacos配置列表](imgs/nacos-config-list.png)
+* 修改 mcs-service-nacos.yml和job-service-nacos.yml
+	 ![redis-change-list.png](imgs/redis-change-list.png)
+*  修改如图所示的密码或端口
+	![redis-change-1.png](imgs/redis-change-1.png)
+   ![redis-change-2.png](imgs/redis-change-2.png)
+
+* 修改后保存即可
+
+### 启动 ldp 服务
+
+```shell
+# 启动
+cd tool/
+./ldp-boot.sh start
+```
+脚本会依次启动base-service（基础服务）、job-service（定时任务服务）、mcs-service（mcs服务）、uaa-service（统一认证服务）、gateway-service（网关服务）、generator（代码生成服务）、service-manage（管理服务）。
+
+基础服务启动时会执行sql对数据库进行初始化，由于mcs、job、uaa等服务启动时依赖基础服务，所以这里会先等基础服务启动完成才会执行其它服务的启动。
+
+可以通过查看status来确认服务是否正常启动
+
+```shell
+# 查看服务状态
+./ldp-boot.sh status
+```
+
+也可以访问地址：http://nacos-server0:8018/nacos
+
+点击服务列表，即可看到以启动并注册的服务信息。如下图：
+
+![nacos服务列表](imgs/nacos-service.png)
+
+如果服务启动失败查看logs/目录下相应的日志文件
+
+### 启动 ldp web 服务
+
+ldp mcs ui 发布
+
+```shell
+# 复制mcs 到 nginx/html 目录
+cp -r ui/mcs /usr/local/nginx/html/ 
+
+```
+
+nginx 配置
+
+```shell
+vim /usr/local/nginx/conf/nginx.conf
+```
+
+```shell
+
+# 配置nginx 服务代理，参考如下
+
+    upstream ldpserver {
+
+        # 关键配置，网关服务地址
+        server gateway-server0:9000 weight=1;
+    }
+ 
+    server {
+        listen       9080;
+        server_name  localhost;
+
+        #charset koi8-r;
+
+        #access_log  logs/host.access.log  main;
+
+        location / {
+            root   html;
+            index  index.html index.htm;
+        }
+
+        #error_page  404              /404.html;
+
+        # redirect server error pages to the static page /50x.html
+        #
+        error_page   500 502 503 504  /50x.html;
+        location = /50x.html {
+            root   html;
+        }
+
+        # proxy the PHP scripts to Apache listening on 127.0.0.1:80
+        #
+        #location ~ \.php$ {
+        #    proxy_pass   http://127.0.0.1;
+        #}
+        #
+
+        # 必需配置
+        location /genservice {
+
+             rewrite ^/(genservice.*) /$1 break;
+             proxy_pass http://127.0.0.1:8600;
+             proxy_set_header Host $host;
+             proxy_set_header X-Real-Ip $remote_addr;
+             proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
+             proxy_set_header X-Forwarded-Proto  $scheme;
+         }
+
+         # 必需配置
+         location ~* /.*-service/ {
+
+             rewrite ^/(.*-service.*) /$1 break;
+             proxy_pass http://ldpserver;
+
+             proxy_set_header Host $host;
+             proxy_set_header X-Real-Ip $remote_addr;
+             proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
+             ## 代理设置 https
+             proxy_set_header X-Forwarded-Proto  $scheme;
+         }
+    }
+
+
+```
+
+
+启动web 服务
+
+```shell
+cd /usr/local/nginx/sbin/
+## 启动服务 
+./nginx
+
+```
+
+访问mcs-ui地址：
+
+http://服务域名或ip:9080/mcs
+
+![mcs登录界面](imgs/login.png)
+
+初始用户名：admin
+初始密码：1234561

README.md

+### LDP 文档汇总
+
+建议根据需求（安装、操作、开发）先阅读根目录的主要文档，如果有其它需求再查看相应具体文档。
+
+安装文档：
+
+​	1、**LDP集中式安装部署说明**
+
+​	2、JRE安装说明
+
+操作文档：
+
+​	1、**LDP-MCS操作手册**
+
+​	2、LDP-MCS新建一个管理员账号
+
+开发文档：
+
+​	1、**基于LDP框架的应用开发文档**
+
+​	2、Example样例工程开发文档
+
+​	3、LDP 框架自定义注解
+
+​	4、git提交规范说明
+
+​	
\ No newline at end of file

安装文档/JRE安装说明.md

+## JRE安装说明（CENTOS）
+
+> 以下安装说明，仅适用于 Server OS：CentOS，其他系统可参考
+
+### 1. 在linux终端中，进入安装包所在目录，解压jre-8u251-linux-x64.tar.gz文件
+#### 
+```shell
+  # 创建/usr/java目录
+  mkdir /usr/java
+  # 解压至/usr/java目录下
+  tar xvf jre-8u251-linux-x64.tar.gz -C /usr/java
+```
+
+### 2. 设置环境变量
+#### 这里我们需要找到profile文件，添加环境变量
+```shell
+vim /etc/profile
+```
+#### 在profile文件下面追加写入下面信息
+```shell
+export JAVA_HOME=/usr/java/jre1.8.0_251
+export CLASSPATH=.:$JAVA_HOME/lib
+export PATH=$PATH:$JAVA_HOME/bin
+```
+#### 使用ESC键，并输入
+```shell
+:wq
+```
+#### 保存退出编辑
+#### 执行以下命令，使配置生效
+```shell
+source /etc/profile
+```

开发文档/git提交规范说明.md

+# git代码提交message规范
+
+目前规范使用较多的是 [Angular 团队的规范](https://link.juejin.im/?target=https%3A%2F%2Flink.zhihu.com%2F%3Ftarget%3Dhttps%3A%2F%2Fgithub.com%2Fangular%2Fangular.js%2Fblob%2Fmaster%2FDEVELOPERS.md%23-git-commit-guidelines), 继而衍生了 [Conventional Commits specification](https://link.juejin.im/?target=https%3A%2F%2Flink.zhihu.com%2F%3Ftarget%3Dhttps%3A%2F%2Fconventionalcommits.org%2F). 很多工具也是基于此规范, 它的 message 格式如下: 
+
+```
+<type>(<scope>): <subject>
+// 空一行
+<body>
+// 空一行
+<footer>
+```
+
+其中，`Header` 是必填，`Body` 和 `Footer` 是选填，`Header` 必填格式如下：  
+
+```
+<type>: <subject>
+
+```
+
+### `Header`
+
+`Header` 包括三个字段：`type`（必填）、`scope`（选填）和 `subject`（必填）
+
+#### `type`
+
+`type` 用于说明 `commit` 的类别，只允许使用下面 7 个标识。
+
+- feat：新功能（feature）
+- fix：修补bug
+- docs：文档（documentation）
+- style： 格式（不影响代码运行的变动）
+- refactor：重构（即不是新增功能，也不是修改bug的代码变动）
+- test：增加测试
+- chore：构建过程或辅助工具的变动
+- perf: 优化相关，比如提升性能、体验
+
+`type` 为 `feat` 和 `fix`，则该 `commit` 将肯定出现在 `Change log` 之中。
+
+#### `scope`
+
+`scope` 用于说明 `commit` 影响的范围，比如数据层、控制层、视图层等等，视项目不同而不同。
+
+#### `subject`
+
+`subject` 是 `commit` 目的的简短描述，不超过50个字符
+
+```
+以动词开头，使用第一人称现在时，比如 change，而不是 changed 或 changes
+第一个字母小写
+结尾不加句号（.）
+```
+
+### `body`
+
+`Body` 部分是对本次 `commit` 的详细描述，可以分成多行。下面是一个范例。
+
+```
+More detailed explanatory text, if necessary.  Wrap it to 
+about 72 characters or so. 
+
+Further paragraphs come after blank lines.
+
+- Bullet points are okay, too
+- Use a hanging indent
+```
+
+### `Footer`
+
+`Footer` 部分只用于两种情况
+
+- 不兼容变动
+
+如果当前代码与上一个版本不兼容，则 `Footer` 部分以 `BREAKING CHANGE` 开头，后面是对变动的描述、以及变动理由和迁移方法。
+
+- 关闭 `Issue` 如果当前 `commit` 针对某个 `issue`，那么可以在 `Footer` 部分关闭这个 `issue`
+
+```
+Closes #123, #245, #992
+```

操作文档/LDP-MCS新建一个管理员账号.md

+# 新建管理员账号
+
+[TOC]
+
+打开LDP-MCS登录界面，使用admin账号登录。
+
+## 1、创建新账号
+
+打开菜单**系统维护**=>**账号管理**，点击**新增**按钮
+
+![用户列表](../progress/36演示-用户列表.png)
+
+在新增界面填入相关信息，这里演示创建一个账号为**demo**，密码为**123456**的账号，用户类型选择根据需求选择**管理**或者**应用**，由于我们是要一个管理账号，所以这里选择**管理**，其它信息根据需求选填，最后点击提交。
+
+![演示新增](../progress/37演示-新增用户.png)
+
+
+
+## 2、创建新角色
+
+*PS：如果已经有管理员角色，可以选择跳过这一节。*
+
+打开菜单**权限管理**=>**角色管理**，点击**新增**按钮
+
+![角色列表](../progress/38演示-角色列表.png)
+
+在新增弹窗中填写角色信息，角色类型一共三种应用、管理、数据，分别对应用菜单权限、管理菜单权限、组织数据权限，这里需要创建一个管理菜单权限的角色，选择**管理**，填入其它信息，点击**提交**按钮。
+
+![新增角色](../progress/39演示-新增角色.png)
+
+## 3、角色关联权限
+
+打开菜单**权限管理**=>**管理菜单权限**
+
+点击角色后面的**权限配置**
+
+![权限配置](../progress/40演示-权限配置.png)
+
+在**备选关联菜单**中勾选需要的权限，这里为了演示，只选择了系统维护中的**账号管理**和**组织管理**，点击**保存**
+
+![关联菜单](../progress/41演示-关联菜单.png)
+
+这样，此角色就拥有了这些权限，接下来将角色和用户关联。
+
+## 4、角色关联账号
+
+将新建的角色与新建的账号关联起来。
+
+![关联用户](../progress/42演示-关联用户.png)
+
+
+
+## 5、切换账号
+
+点击右上角头像，点击**退出登录**，会直接跳转到登录界面。
+
+![退出登录](../progress/43演示-退出登录.png)
+
+在登录界面重新登录刚才创建的demo账号
+
+![登录demo](../progress/44演示-登录demo.png)
+
+## 6、何查权限
+
+检查权限是否与角色配置一致（账号权限为所有关联角色的权限总和，例如：账号同时关联角色A、角色B，角色A权限为**账号管理**，角色B权限为**职位管理**，那么此账号将同时拥有**账号管理**和**职位管理**权限）
+
+![核查权限](../progress/45演示-核查权限.png)
+
+在[3、角色关联权限](#3、角色关联权限)中，demo管理角色只关联了**账号管理**和**组织管理**，所以菜单中也只有**账号管理**和**组织管理**。
+
+## 7、修改密码
+
+新账号登录后，如果需要修改当前账号密码，点击右上角头像，再点击修改密码。在修改密码弹窗中填入旧密码、新密码点击**提交**。
+
+![修改密码](../progress/46演示-修改密码.png)
+