[doc]feature: update contributor guide and gif show (apache#155)

* Add @ChineseTony as a contributor * [doc]feature: update contributor guide and gif show
brave4Time · May 29, 2022 · bbcd347 · bbcd347
1 parent 63ee5ed
commit bbcd347
Show file tree

Hide file tree

Showing 10 changed files with 321 additions and 84 deletions.
diff --git a/.all-contributorsrc b/.all-contributorsrc
@@ -124,6 +124,15 @@
         "code",
         "bug"
       ]
+    },
+    {
+      "login": "ChineseTony",
+      "name": "ChineseTony",
+      "avatar_url": "https://avatars.githubusercontent.com/u/24618786?v=4",
+      "profile": "https://github.com/ChineseTony",
+      "contributions": [
+        "code"
+      ]
     }
   ],
   "contributorsPerLine": 7

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
diff --git a/README.md b/README.md
@@ -8,7 +8,7 @@
 
 ## HertzBeat | [中文文档](README_CN.md)   
 
-> Friendly cloud monitoring system. | 易用友好的云监控系统, 无需Agent, 强大自定义监控能力.   
+> Friendly Cloud Monitoring System. | 易用友好的云监控系统, 无需Agent, 强大自定义监控能力.   
 
 [![Gitter](https://badges.gitter.im/hertzbeat/community.svg)](https://gitter.im/hertzbeat/community?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge)
 ![tan-cloud](https://img.shields.io/badge/web-monitor-4EB1BA)
@@ -39,29 +39,18 @@ Running HertzBeat in [OSCR.COM](https://osrc.com) Open Source Runtime Community
 
 ----   
 
-[![tancloud](tancloud.gif)](https://www.bilibili.com/video/BV1DY4y1i7ts)             
+[![hertzbeat](hertzbeat.gif)](https://www.bilibili.com/video/BV1DY4y1i7ts)             
 
 ----   
 
 ## 🥐 Architecture  
 
-- **[manager](https://github.com/dromara/hertzbeat/tree/master/manager)** Provide monitoring management, system management basic services.  
-> Provides monitoring management, monitoring configuration management, system user management, etc.  
-- **[collector](https://github.com/dromara/hertzbeat/tree/master/collector)** Provide metrics data collection services.
-> Use common protocols to remotely collect and obtain peer-to-peer metrics data.   
-- **[warehouse](https://github.com/dromara/hertzbeat/tree/master/warehouse)** Provide monitoring data warehousing services. 
-> Metrics data management, data query, calculation and statistics.  
-- **[alerter](https://github.com/dromara/hertzbeat/tree/master/alerter)** Provide alert service.  
-> Alarm calculation trigger, monitoring status linkage, alarm configuration, and alarm notification.   
-- **[web-app](https://github.com/dromara/hertzbeat/tree/master/web-app)** Provide web ui.  
-> Angular Web UI.    
-
 ![hertzBeat](home/static/img/docs/hertzbeat-stru-en.svg)     
 
 
 ## 🐕 Quick Start   
 
-- If you don’t want to deploy but use it directly, we provide [SAAS Monitoring Cloud-TanCloud](https://console.tancloud.cn), **[Log In And Register For Free](https://console.tancloud.cn) **. 
+- If you don’t want to deploy but use it directly, we provide [SAAS Monitoring Cloud-TanCloud](https://console.tancloud.cn), **[Log In And Register For Free](https://console.tancloud.cn)**.   
 - If you want to deploy HertzBeat local, please refer to the following [Deployment Documentation](https://hertzbeat.com/docs/start/quickstart) for operation.  
 
 ### 🐵 Dependency Service Deployment   
@@ -74,21 +63,21 @@ Running HertzBeat in [OSCR.COM](https://osrc.com) Open Source Runtime Community
 2. Create database names `hertzbeat`   
 3. Run the database sql script [schema.sql](https://gitee.com/dromara/hertzbeat/raw/master/script/sql/schema.sql) located in the project repository `/script/sql/` directory.     
 
-For detailed steps, refer to [MYSQL Installation And Initialization](https://hertzbeat.com/docs/start/mysql-init)   
+For detailed steps, refer to [MYSQL Install And Init](https://hertzbeat.com/docs/start/mysql-init)   
 
 ##### Install TDengine
 1. Install TDengine with docker     
    `docker run -d -p 6030-6049:6030-6049 -p 6030-6049:6030-6049/udp --name tdengine tdengine/tdengine:2.4.0.12`
 2. Create database names `hertzbeat`   
 
-For detailed steps, refer to [TDengine Installation And Initialization](https://hertzbeat.com/docs/start/tdengine-init).  
+For detailed steps, refer to [TDengine Install And Init](https://hertzbeat.com/docs/start/tdengine-init).  
 
 ### 🍞 Install HertzBeat   
 
 > HertzBeat supports installation through source code, docker or package.   
 
 ##### 1：Install quickly via docker   
-`docker run -d -p 1157:1157 -v /opt/application.yml:/opt/hertzbeat/config/application.yml --name hertzbeat tancloud/hertzbeat:[版本tag]`
+`docker run -d -p 1157:1157 -v /opt/application.yml:/opt/hertzbeat/config/application.yml --name hertzbeat tancloud/hertzbeat:[version]`
 
 Detailed steps refer to [Install HertzBeat via Docker](https://hertzbeat.com/docs/start/docker-deploy)   
 
@@ -98,11 +87,11 @@ Detailed steps refer to [Install HertzBeat via Docker](https://hertzbeat.com/doc
 3. Run shell `$ ./startup.sh `
 4. Access `localhost:1157` to start, default account: `admin/hertzbeat`  
 
-Detailed steps refer to [Install HertzBeat via package](https://hertzbeat.com/docs/start/package-deploy)   
+Detailed steps refer to [Install HertzBeat via Package](https://hertzbeat.com/docs/start/package-deploy)   
 
 ##### 3：Start via source code        
 1. Local source code debugging needs to start the back-end project manager and the front-end project web-app.  
-2. Backend：need `maven3+`, `java8+`, start the manager service.  
+2. Backend：need `maven3+`, `java8+`, `lombok`, start the manager service.  
 3. Web：need `nodejs npm angular-cli` environment, Run `ng serve --open` in `web-app` directory after backend startup.  
 4. Access `localhost:4200` to start, default account: `admin/hertzbeat`  
 
@@ -112,13 +101,14 @@ Detailed steps refer to [CONTRIBUTING](CONTRIBUTING.md)
 
 Install and deploy the mysql database, tdengine database and hertzbeat at one time through [docker-compose deployment script](script/docker-compose).
 
-Detailed steps refer to [docker-compose install](script/docker-compose/README.md)      
+Detailed steps refer to [Install via Docker-Compose](script/docker-compose/README.md)      
 
 **HAVE FUN**  
 
 ## ✨ Contributors
 
-Thanks these wonderful people, welcome to join us:
+Thanks these wonderful people, welcome to join us:   
+[CONTRIBUTING](CONTRIBUTING.md)   
 
 <!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
 <!-- prettier-ignore-start -->
@@ -138,6 +128,7 @@ Thanks these wonderful people, welcome to join us:
     <td align="center"><a href="https://github.com/brave4Time"><img src="https://avatars.githubusercontent.com/u/105094014?v=4?s=100" width="100px;" alt=""/><br /><sub><b>brave4Time</b></sub></a><br /><a href="https://github.com/tomsun28/hertzbeat/commits?author=brave4Time" title="Code">💻</a> <a href="https://github.com/tomsun28/hertzbeat/issues?q=author%3Abrave4Time" title="Bug reports">🐛</a></td>
     <td align="center"><a href="https://github.com/walkerlee-lab"><img src="https://avatars.githubusercontent.com/u/8426753?v=4?s=100" width="100px;" alt=""/><br /><sub><b>WalkerLee</b></sub></a><br /><a href="https://github.com/tomsun28/hertzbeat/commits?author=walkerlee-lab" title="Code">💻</a> <a href="https://github.com/tomsun28/hertzbeat/issues?q=author%3Awalkerlee-lab" title="Bug reports">🐛</a></td>
     <td align="center"><a href="https://github.com/fullofjoy"><img src="https://avatars.githubusercontent.com/u/30247571?v=4?s=100" width="100px;" alt=""/><br /><sub><b>jianghang</b></sub></a><br /><a href="https://github.com/tomsun28/hertzbeat/commits?author=fullofjoy" title="Code">💻</a> <a href="https://github.com/tomsun28/hertzbeat/issues?q=author%3Afullofjoy" title="Bug reports">🐛</a></td>
+    <td align="center"><a href="https://github.com/ChineseTony"><img src="https://avatars.githubusercontent.com/u/24618786?v=4?s=100" width="100px;" alt=""/><br /><sub><b>ChineseTony</b></sub></a><br /><a href="https://github.com/tomsun28/hertzbeat/commits?author=ChineseTony" title="Code">💻</a></td>
   </tr>
 </table>
 

diff --git a/README_CN.md b/README_CN.md
@@ -38,22 +38,11 @@
 
 ----   
 
-[![tancloud](tancloud.gif)](https://www.bilibili.com/video/BV1DY4y1i7ts)             
+[![hertzbeat](hertzbeat.gif)](https://www.bilibili.com/video/BV1DY4y1i7ts)             
 
 ----   
 
-## 🥐 模块
-
-- **[manager](https://github.com/dromara/hertzbeat/tree/master/manager)** 提供监控管理,系统管理基础服务
-> 提供对监控的管理，监控应用配置的管理，系统用户租户后台管理等。
-- **[collector](https://github.com/dromara/hertzbeat/tree/master/collector)** 提供监控数据采集服务
-> 使用通用协议远程采集获取对端指标数据。
-- **[warehouse](https://github.com/dromara/hertzbeat/tree/master/warehouse)** 提供监控数据仓储服务
-> 采集指标结果数据管理，数据落盘，查询，计算统计。
-- **[alerter](https://github.com/dromara/hertzbeat/tree/master/alerter)** 提供告警服务
-> 告警计算触发，监控状态联动，告警配置，告警通知。
-- **[web-app](https://github.com/dromara/hertzbeat/tree/master/web-app)** 提供可视化控制台页面
-> 监控告警系统可视化控制台前端  
+## 🥐 模块  
 
 ![hertzBeat](https://cdn.jsdelivr.net/gh/dromara/hertzbeat@gh-pages/img/docs/hertzbeat-stru.svg)   
 
@@ -112,7 +101,7 @@
 
 通过 [docker-compose部署脚本](script/docker-compose) 一次性把mysql数据库,tdengine数据库和hertzbeat安装部署。   
 
-详细步骤参考 [docker-compose安装](script/docker-compose/README.md)   
+详细步骤参考 [通过Docker-Compose安装HertzBeat](script/docker-compose/README.md)   
 
 **HAVE FUN**
 
@@ -138,6 +127,7 @@ Thanks these wonderful people, welcome to join us:
     <td align="center"><a href="https://github.com/brave4Time"><img src="https://avatars.githubusercontent.com/u/105094014?v=4?s=100" width="100px;" alt=""/><br /><sub><b>brave4Time</b></sub></a><br /><a href="https://github.com/tomsun28/hertzbeat/commits?author=brave4Time" title="Code">💻</a> <a href="https://github.com/tomsun28/hertzbeat/issues?q=author%3Abrave4Time" title="Bug reports">🐛</a></td>
     <td align="center"><a href="https://github.com/walkerlee-lab"><img src="https://avatars.githubusercontent.com/u/8426753?v=4?s=100" width="100px;" alt=""/><br /><sub><b>WalkerLee</b></sub></a><br /><a href="https://github.com/tomsun28/hertzbeat/commits?author=walkerlee-lab" title="Code">💻</a> <a href="https://github.com/tomsun28/hertzbeat/issues?q=author%3Awalkerlee-lab" title="Bug reports">🐛</a></td>
     <td align="center"><a href="https://github.com/fullofjoy"><img src="https://avatars.githubusercontent.com/u/30247571?v=4?s=100" width="100px;" alt=""/><br /><sub><b>jianghang</b></sub></a><br /><a href="https://github.com/tomsun28/hertzbeat/commits?author=fullofjoy" title="Code">💻</a> <a href="https://github.com/tomsun28/hertzbeat/issues?q=author%3Afullofjoy" title="Bug reports">🐛</a></td>
+    <td align="center"><a href="https://github.com/ChineseTony"><img src="https://avatars.githubusercontent.com/u/24618786?v=4?s=100" width="100px;" alt=""/><br /><sub><b>ChineseTony</b></sub></a><br /><a href="https://github.com/tomsun28/hertzbeat/commits?author=ChineseTony" title="Code">💻</a></td>
   </tr>
 </table>
 

diff --git a/tancloud.gif → hertzbeat.gif b/tancloud.gif → hertzbeat.gif
diff --git a/home/src/pages/index.js b/home/src/pages/index.js
@@ -19,6 +19,7 @@ import { features, SetupExample, SurenessIntegration, friendLinks, mediaPartners
 function Home() {
     const context = useDocusaurusContext()
     const {siteConfig = {}} = context
+    loadGitter();
     return (
         <Layout
             title={`${siteConfig.title} · ${siteConfig.tagline}`}
@@ -78,3 +79,21 @@ function Home() {
 }
 
 export default Home
+
+function loadGitter() {
+    return new Promise(function (resolve, reject) {
+        var script = document.createElement('script')
+        script.type = 'text/javascript'
+        script.async = true;
+        script.src = 'https://sidecar.gitter.im/dist/sidecar.v1.js';
+        ((window.gitter = {}).chat = {}).options = {
+            room: 'hertzbeat/community'
+        };
+        script.onload = function () {
+            ((window.gitter = {}).chat = {}).options = {
+                room: 'hertzbeat/community'
+            };
+        }
+        document.body.appendChild(script)
+    })
+}
diff --git a/manager/src/main/resources/application.yml b/manager/src/main/resources/application.yml
@@ -59,7 +59,7 @@ spring:
     suffix: .html
     #encoding: UTF-8
     #content-type: text/html
-    mode: LEGACYHTML5
+    mode: HTML
 
 warehouse:
   store:

diff --git a/manager/src/main/resources/logback-spring.xml b/manager/src/main/resources/logback-spring.xml
@@ -58,6 +58,10 @@
     <logger name="org.slf4j" level="info"/>
     <logger name="ch.qos.logback" level="info"/>
     <logger name="org.apache.kafka.clients" level="info"/>
+    <logger name="org.hibernate" level="info"/>
+    <logger name="org.apache.http" level="info"/>
+    <logger name="com.zaxxer" level="info"/>
+    <logger name="springfox" level="info"/>
 
     <!-- 生产环境配置 -->
     <springProfile name="prod">
@@ -70,7 +74,7 @@
 
     <!-- 开发环境配置 -->
     <springProfile name="dev">
-        <root level="INFO">
+        <root level="DEBUG">
             <appender-ref ref="ConsoleAppender"/>
             <appender-ref ref="SystemOutFileAppender"/>
             <appender-ref ref="ErrOutFileAppender"/>

diff --git a/script/application.yml b/script/application.yml
@@ -58,7 +58,7 @@ spring:
     suffix: .html
     #encoding: UTF-8
     #content-type: text/html
-    mode: LEGACYHTML5
+    mode: HTML
 
 warehouse:
   store:

diff --git a/script/docker-compose/conf/application.yml b/script/docker-compose/conf/application.yml
@@ -58,7 +58,7 @@ spring:
     suffix: .html
     #encoding: UTF-8
     #content-type: text/html
-    mode: LEGACYHTML5
+    mode: HTML
 
 warehouse:
   store: