Skip to content

Commit

Permalink
[improve] improve md format MD025 (#2587)
Browse files Browse the repository at this point in the history
  • Loading branch information
Aias00 authored Aug 25, 2024
1 parent e3a1b83 commit 7facbe8
Show file tree
Hide file tree
Showing 19 changed files with 130 additions and 130 deletions.
2 changes: 1 addition & 1 deletion .markdownlint-cli2.jsonc
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@
"MD024": {
"siblings_only": true
},
"MD025": false,
"MD025": true,
"MD029": false,
"MD033": false,
"MD035": false,
Expand Down
26 changes: 13 additions & 13 deletions home/blog/2022-12-19-new-committer.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ tags: [opensource]

> 非常高兴 HertzBeat 迎来了两位新晋社区Committer, 两位都是来自互联网公司的开发工程师,让我们来了解下他们的开源经历吧!
# 第一位 花城
## 第一位 花城

姓名:王庆华

Expand All @@ -19,15 +19,15 @@ HertzBeat Committer

github:[wang1027-wqh](https://github.com/wang1027-wqh)

## 初识hertzbeat
### 初识hertzbeat

说起来挺偶然的,结识hertzbeat是因为我大学的毕业设计,当时在一家互联网公司实习,那个时候第一次看到了企业是怎么监控项目的,不管是系统监控、业务监控还是物联网iot监控,那个时候见世面不广,只知道Prometheus + Grafana,但是学起来、用起来成本比较高,那个时候就觉得应该有其他类型的监控,恰好,到了大学毕业设计选题,我就开始寻找这方面的开源项目,那个时候我们小组正在使用Shen Yu网关,我就看了下社区,发现了hertzbeat,自此我便于它结缘了。

## 开始提交PR
### 开始提交PR

到了2022-02-18 我开始提交了我第一个pr,当时只是为了优化一些controller入参的格式,没有什么技术含量,但是这是我接触开源的第一步,让我在从理论学习跨出了实践的一步

## 持续的开源贡献与收获
### 持续的开源贡献与收获

到目前为止,参与hertzbeat开源项目已有半年多时间,贡献了许多,也成长收获了许多。具体如下:

Expand All @@ -37,11 +37,11 @@ github:[wang1027-wqh](https://github.com/wang1027-wqh)
4. 参与了开源之夏并顺利结项
5. 增加了监控系统的基础告警功能: 钉钉、飞书、企业微信、邮箱等

## 感谢社区小伙伴
### 感谢社区小伙伴

感谢无偿帮助过我或给过我启发的小伙伴(排名不分先后):tomsun28,MaxKeyTop,阿超

## 对新人的一点建议
### 对新人的一点建议

1. 不要觉得自己一上手就能接触到核心,心急吃不了热豆腐
2. 不要只注重看代码,要上手搭建、使用
Expand All @@ -51,7 +51,7 @@ github:[wang1027-wqh](https://github.com/wang1027-wqh)
---
---

# 第二位 星辰
## 第二位 星辰

姓名:郑晨鑫

Expand All @@ -63,11 +63,11 @@ Hertzbeat Committer

github:[Ceilzcx (zcx) (github.com)](https://github.com/Ceilzcx)

## 初识Hertzbeat
### 初识Hertzbeat

2022年8月开始接触Hertzbeat,由于公司监控elasticsearch使用的cerebro,虽然有非常强大的数据监控,但缺少告警通知的功能;就去github上浏览监控类的项目,刚好看到Hertzbeat,对此非常感兴趣,在了解完整个项目结构和实现后,刚好elasticsearch的监控部分做的不够完善,我就根据cerebro完善了这部分监控数据并提交了pull request。后面在tom老哥的帮助下也开始其他部分的实现。

## 开始提交PR
### 开始提交PR

从2022年9月至今提交了好几个pr,主要包括:

Expand All @@ -78,25 +78,25 @@ github:[Ceilzcx (zcx) (github.com)](https://github.com/Ceilzcx)
+ 一些bug的修复。。。
+ promethues exporter 协议解析

## 持续的开源贡献与收获
### 持续的开源贡献与收获

到目前为止,参与Hertzbeat社区开源已有半年多时间,贡献了许多,也成长收获了许多。

在参与开源的时候会比平常自己做项目想的更多,包括使用第三方软件各个版本如何兼容;实现某个功能也要考虑是否方便以后扩展;要有完善的test模块,减少项目的bug。

同时在社区群里,看到别人提的问题和帮助别人可以学到很多新的知识,很多问题你目前不一定会遇到,其他人遇到的时候你可以思考并收获很多知识。

## 感谢社区小伙伴
### 感谢社区小伙伴

感谢无偿帮助过我或给过我启发的小伙伴:[tomsun28](https://github.com/tomsun28)

## 对新人的一点建议
### 对新人的一点建议

+ 使用者可以先看官网,官网基本能够解决你的问题。部分简单或者常见的问题其他可以自己解决,对自己也是一种锻炼
+ 可以尝试阅读源码,大部分源码都是包含注释的,并不难;不懂的地方也可以通过运行test,debug看一下整个流程
+ 有想法或者bug,可以前往gitee或者github提交issues,也可以在群里询问,不要怕,都是从菜逼过来的

## 如何参与Hertzbeat
### 如何参与Hertzbeat

+ 官网有非常完善的贡献者指南:[贡献者指南 | HertzBeat](https://hertzbeat.com/docs/community/contribution)

Expand Down
2 changes: 1 addition & 1 deletion home/blog/2023-02-10-new-committer.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ tags: [opensource]

![hertzBeat](/img/blog/new-committer.png)

# Welcome two new Committers from HertzBeat
## Welcome two new Committers from HertzBeat

> I am very happy that the HertzBeat open source community has welcomed two new community Committers, one is the leader of the R&D team from the front line, and the other is an intern from a large factory. Let us learn about their open source experience!
Expand Down
42 changes: 21 additions & 21 deletions home/blog/2024-01-11-new-committer.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,115 +12,115 @@ keywords: [open source monitoring system, alerting system]

> Welcome to HertzBeat's three new community committeers, let's learn more about their open source experience!
# New Committer - vinci
## New Committer - vinci

**Name: Wang Jianing**

**First year graduate student, School of Computer Science, Zhejiang University**

**Github ID: vinci-897**

## Getting to know Hertzbeat for the first time
### Getting to know Hertzbeat for the first time

In March 2023, I noticed Hertzbeat's project, so I directly sent an email to Tom in the community to ask if I could join, and he replied very quickly. It just so happened that I was in my senior year of college when I had more time, so I decisively picked an issue to resolve and had my first pull request at Hertzbeat.

## Start submitting PR
### Start submitting PR

In the following period, I spent some time reading Hertzbeat's code, and submitted a few PRs off and on until April, when I learned about the Summer of Open Source event, and it just so happened that Hertzbeat was participating as well, so I submitted my application information and was selected. My task is mainly responsible for the implementation of a push collector, in the process of writing the code, I got a lot of community mentor Zheng Chenxin and Tom to help, and finally was able to successfully complete the code, the whole process is still relatively smooth.

## Open source contributions
### Open source contributions

- Add push module to expose interface for users to push data.
- Implement the collection of push data in the collector module.
- Implement user-defined data display in the front-end.

## Harvest
### Harvest

- Exposed to a great open source community and improved my skills in related areas.

Thanks to Tom and my ospp mentor, Zheng Chenxin, who gave me a lot of help and advice during my exposure to the open source community. Currently I am still in charge of some of the code development in the community, I hope Hertzbeat can be better and better in the future!

---

# New Committer - SongXiao
## New Committer - SongXiao

**Name: Zhou Shusheng**

**Junior student at Henan Normal University**

## Getting to know Hertzbeat for the first time
### Getting to know Hertzbeat for the first time

In March this year, under the influence of Xiaobao's seniors, I had some concepts about open source projects and laid the foundation for learning open source projects later, but I didn't go further because I only learned some Java basics at that time.

## Start submitting PR
### Start submitting PR

In July this year, after basically completing the study of Java framework development, with the encouragement of Xiaobao, I started to try to pull issues, and submitted my first PR on July 20, during this period, I also consulted with the author of Hertzbeat and Dongfeng for some related issues, thank you very much.

## Open source contributions
### Open source contributions

- Support for Spring Gateway, Apache Spark, Apache Hive and other services metrics collection
- Customize nginx and pop3 protocols to collect metrics for Nginx and POP3 mailbox servers, and add corresponding help files.

## Harvest
### Harvest

- Exposed to better and more complex large-scale projects, improved programming and problem-solving skills.
- Put the theoretical knowledge into practice, gained JUC, microservice related development experience, and valuable project experience.

## Thanks to our community partners
### Thanks to our community partners

Thanks to the author of HertzBeat, HertzBeat/Sms4j Committer Tiejia Xiaobao, Sms4j Committer Dongfeng, when I encountered problems that I could not solve, I often asked the three brothers to ask for advice, and they are always tired of patiently helping me solve the problem, there are really no words.

Thanks to the other partners in the community, I've gained a lot from communicating and discussing with them, and I've also felt the active open source atmosphere in the community.

## Some advice for newcomers
### Some advice for newcomers

- When you first get involved in an open source project, start with simple tasks. Gradually familiarize yourself with the code and process of the project, and gradually take on more complex tasks.
- If you encounter problems that you can't solve by yourself, you can ask for help from the community.

---

# New Committer - Dongfeng
## New Committer - Dongfeng

**Name: Zhang Yang

**Freshman from Henan Normal University**

## Getting to know hertzbeat for the first time
### Getting to know hertzbeat for the first time

In June of this year, I started to learn more about the project, I was recommended by a friend to learn about the project, I have been exploring open source projects and communities, and I like the atmosphere of sharing, discussing and improving each other. At the same time, I also tried to implement some monitoring in my previous projects, so I am more interested in this project.

## Start submitting PR
### Start submitting PR

Since July this year, I found hertzbeat's issues and prs are very active, so I went through their issues and prs to find out how to implement monitoring for a certain protocol. Then I found out that there is a task about smtp protocol monitoring, so I discussed with the author on the issue, and then I finished my pr through documentation and code.

## Open source contributions
### Open source contributions

- Implementation of smtp, ntp, websocket availability monitoring.
- Implement monitoring metrics for memcached and NebulaGraph.
- Add documentation for the implemented monitoring.

## Harvest
### Harvest

- Gained monitoring-related development experience and added a valuable project experience.
- Gained a deeper understanding of network protocols.
- I gained a deeper understanding of network protocols. I gained a preliminary understanding of the contribution process of open source projects.

## Thank you to our community partners
### Thank you to our community partners

Thanks to the authors of hertzbeat for the documentation and help. Thanks to my friends for providing me with the courage to try to enter the open source project to contribute. Thanks to other community members for their issues and prs, which accelerated my understanding of the project.

## A bit of advice for newcomers
### A bit of advice for newcomers

- Issues and pr's are the knock on the door of the project you are getting to know, so be willing to discuss and express your opinion.
- No matter how big or small your contribution is, be willing to try and keep improving yourself.

----

## What is HertzBeat?
### What is HertzBeat?

[HertzBeat HertzBeat](https://github.com/apache/hertzbeat) is an open source real-time monitoring and alerting system with powerful customizable monitoring capabilities, high performance clustering, Prometheus compatibility, and no Agent required.

### Features
#### Features

- Integrate **Monitoring+Alerting+Notification** into one system, support monitoring thresholds and alerting notifications for application services, applications, databases, caches, operating systems, big data, middleware, web servers, cloud-native, networks, customization, etc. in one step.
- Easy to use and friendly, no need for `Agent`, full `WEB` page operation, a little mouse click to monitor alarms, zero start-up learning costs.
Expand Down
2 changes: 1 addition & 1 deletion home/blog/2024-01-18-hertzbeat-v1.4.4.md
Original file line number Diff line number Diff line change
Expand Up @@ -83,7 +83,7 @@ Detailed config refer to [Install HertzBeat via Docker](https://hertzbeat.com/do
* add prolevel1 as a contributor for code by @allcontributors in <https://github.com/apache/hertzbeat/pull/1415>
*

# 1397 feature: support for dns monitoring by @Calvin979 in <https://github.com/apache/hertzbeat/pull/1416>
## 1397 feature: support for dns monitoring by @Calvin979 in <https://github.com/apache/hertzbeat/pull/1416>

* Support monitoring hive metrics by @a-little-fool in <https://github.com/apache/hertzbeat/pull/1417>
* support legend pageable in history data charts by @tomsun28 in <https://github.com/apache/hertzbeat/pull/1414>
Expand Down
4 changes: 2 additions & 2 deletions home/blog/2024-07-07-new-committer.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,15 +16,15 @@ I have been working in backend development since I started my career in 2015, en

I have always been passionate about the open-source community, and I am also a Committer for Apache Pulsar and a Contributor for OpenTelemetry and VictoriaMetrics.

# My Connection with HertzBeat
## My Connection with HertzBeat

In April of this year, when HertzBeat entered the Apache Incubator, I happened to see a recommendation on a WeChat public account in my social circle.

My first reaction was that the name was really well chosen 😄. Then, after looking closely at the features it provides and the problems it solves, I realized its powerful functionalities 💪.

Since I also need to maintain an observability system at my company, and I have participated in an open-source project called cprobe (which has some similar goals to HertzBeat), I have some experience with monitoring systems and a strong interest in them. Therefore, I read the documentation and quickly started it locally (the community has done a great job in this regard, as many open-source projects lose potential developers right at the initial startup step).

# Starting Contributions
## Starting Contributions

My first PR was to fix an incorrect path in a PR template, and the community responded very quickly, which gave me a very positive impression.

Expand Down
24 changes: 12 additions & 12 deletions home/docs/community/how-to-verify.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,13 +4,13 @@ title: How to Verify Release
sidebar_position: 4
---

# Verify the candidate version
## Verify the candidate version

For detailed check list, please refer to the official [check list](https://cwiki.apache.org/confluence/display/INCUBATOR/Incubator+Release+Checklist)

Version content accessible in browser <https://dist.apache.org/repos/dist/dev/incubator/hertzbeat/>

## 1. Download the candidate version
### 1. Download the candidate version

Download the candidate version to be released to the local environment Need to rely on gpg tool, if not, it is recommended to install `gpg2`.

Expand All @@ -27,11 +27,11 @@ $ svn co https://dist.apache.org/repos/dist/dev/incubator/hertzbeat/${release_ve
$ wget https://dist.apache.org/repos/dist/dev/incubator/hertzbeat/${release_version}-${rc_version}/xxx.xxx
```

## 2. Verify that the uploaded version is compliant
### 2. Verify that the uploaded version is compliant

Start the verification process, which includes but is not limited to the following content and forms.

### 2.1 Check whether the release package is complete
#### 2.1 Check whether the release package is complete

The package uploaded to dist must include the source code package, and the binary package is optional.

Expand All @@ -40,18 +40,18 @@ The package uploaded to dist must include the source code package, and the binar
3. Whether to include the sha512 of the source code package
4. If the binary package is uploaded, also check the contents listed in (2)-(4)

### 2.2 Check gpg signature
#### 2.2 Check gpg signature

First import the publisher's public key. Import KEYS from the svn repository to the local environment. (The person who releases the version does not need to import it again, the person who helps to do the verification needs to import it, and the user name is enough for the person who issued the version)

#### 2.2.1 Import public key
##### 2.2.1 Import public key

```shell
curl https://downloads.apache.org/incubator/hertzbeat/KEYS > KEYS # Download KEYS
gpg --import KEYS # Import KEYS to local
```

#### 2.2.2 Trust the public key
##### 2.2.2 Trust the public key

Trust the KEY used in this version:

Expand Down Expand Up @@ -80,7 +80,7 @@ gpg>
```
#### 2.2.3 Check the gpg signature
##### 2.2.3 Check the gpg signature
```shell
for i in *.tar.gz; do echo $i; gpg --verify $i.asc $i; done
Expand All @@ -97,13 +97,13 @@ gpg: using RSA key XXXXX
gpg: Good signature from "xxx @apache.org>"
```
### 2.3 Check sha512 hash
#### 2.3 Check sha512 hash
```shell
for i in *.tar.gz; do echo $i; sha512sum --check $i.sha512; done
```
### 2.4 Check the binary package
#### 2.4 Check the binary package
unzip `apache-hertzbeat-${release.version}-incubating-bin.tar.gz`
Expand All @@ -123,7 +123,7 @@ check as follows:
- [ ] Able to compile correctly
- [ ] .....
### 2.5 Check the source package
#### 2.5 Check the source package
> If the binary/web-binary package is uploaded, check the binary package.
Expand All @@ -149,7 +149,7 @@ and check as follows:
You can refer to this article: [ASF Third Party License Policy](https://apache.org/legal/resolved.html)
## 3. Email reply
### 3. Email reply
If you initiate a posting vote, you can refer to this response example to reply to the email after verification
<font color="red">
Expand Down
6 changes: 3 additions & 3 deletions home/docs/help/http_sd.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ keywords: [open source monitoring tool, open source java monitoring tool, monito
**Protocol Use:httpsd**

# Steps to monitor micro services
## Steps to monitor micro services

1. Make sure your **Register center** is available

Expand All @@ -18,7 +18,7 @@ keywords: [open source monitoring tool, open source java monitoring tool, monito
2. Add http_sd monitor and enter necessary info about **Register center** on Hertzbeat, such as host, port and so on.
3. Click **OK**

# Configuration parameter
## Configuration parameter

| Parameter name | Parameter help description |
|-----------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
Expand All @@ -30,7 +30,7 @@ keywords: [open source monitoring tool, open source java monitoring tool, monito
| Whether to detect | Whether to detect and check the availability of monitoring before adding monitoring. Adding and modifying operations will continue only after the detection is successful |
| Description remarks | For more information about identifying and describing this monitoring, users can note information here |

# Collection Metrics
## Collection Metrics

## Metrics Set:server

Expand Down
Loading

0 comments on commit 7facbe8

Please sign in to comment.