Skip to content

Commit

Permalink
update home website doc (apache#1712)
Browse files Browse the repository at this point in the history
Signed-off-by: tomsun28 <[email protected]>
Co-authored-by: Logic <[email protected]>
  • Loading branch information
tomsun28 and zqr10159 authored Apr 6, 2024
1 parent c7a82e1 commit f8190c4
Show file tree
Hide file tree
Showing 123 changed files with 338 additions and 1,038 deletions.
22 changes: 3 additions & 19 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -110,17 +110,9 @@ With the above steps, you are a contributor to HertzBeat. Repeat the previous st

### Join Discussion

[Gitter Channel](https://gitter.im/hertzbeat/community)

[Github Discussion](https://github.com/dromara/hertzbeat/discussions)

[User Club](https://support.qq.com/products/379369)

Add WeChat account `tan-cloud` to pull you into the WeChat group.

QQ group number `236915833`, verify code: `tancloud`

Public WeChat: `tancloudtech`
Add WeChat account `tan-cloud` to pull you into the WeChat group.

## 🥐 Architecture

Expand Down Expand Up @@ -252,19 +244,11 @@ git pull upstream master

通过上述步骤,您就是 HertzBeat 的贡献者了。重复前面的步骤,在社区中保持活跃,坚持下去,您就能成为 Committer!

### 加入讨论交流

[Gitter Channel](https://gitter.im/hertzbeat/community)
### 加入讨论交流

[Github Discussion](https://github.com/dromara/hertzbeat/discussions)

[HertzBeat答疑网站](https://support.qq.com/products/379369)

加微信号 `tan-cloud` 拉您进微信交流群

加QQ群号 `236915833` 进QQ交流群, 验证信息: `tancloud`

微信公众号: `tancloudtech`
加微信号 `tan-cloud` 拉您进微信交流群

### 模块

Expand Down
3 changes: 1 addition & 2 deletions home/docs/introduce.md
Original file line number Diff line number Diff line change
Expand Up @@ -146,7 +146,7 @@ In an isolated network where multiple networks are not connected, we need to dep
- An open source collaboration product using the `Apache2` protocol, maintained by a free and open source community.
- No monitoring number `License`, monitoring type and other pseudo-open source restrictions .
- Built on `Java+SpringBoot+TypeScript+Angular` mainstream technology stack , convenient secondary development .
- Open source is not the same as free, dev based on HertzBeat must retain the logo, name, page footnotes, copyright, etc.
- Open source is not the same as free, dev based on HertzBeat must retain page footnotes, copyright, etc.


**HertzBeat has been included in the [CNCF Observability And Analysis - Monitoring Landscape](https://landscape.cncf.io/card-mode?category=monitoring&grouping=category)**
Expand Down Expand Up @@ -310,6 +310,5 @@ Built-in support for monitoring types include:

-----

**Home: https://hertzbeat.com/**
**Github: https://github.com/dromara/hertzbeat**
**Gitee: https://gitee.com/dromara/hertzbeat**
10 changes: 1 addition & 9 deletions home/docs/others/contributing.md
Original file line number Diff line number Diff line change
Expand Up @@ -114,18 +114,10 @@ With the above steps, you are a contributor to HertzBeat. Repeat the previous st

### Join Discussion

[Gitter Channel](https://gitter.im/hertzbeat/community)

[Github Discussion](https://github.com/dromara/hertzbeat/discussions)

[User Club](https://support.qq.com/products/379369)

Add WeChat account `tan-cloud` to pull you into the WeChat group.

QQ group number `236915833`, verify code: `tancloud`

Public WeChat: `tancloudtech`

## 🥐 Architecture

- **[manager](https://github.com/dromara/hertzbeat/tree/master/manager)** Provide monitoring management, system management basic services.
Expand All @@ -139,4 +131,4 @@ Public WeChat: `tancloudtech`
- **[web-app](https://github.com/dromara/hertzbeat/tree/master/web-app)** Provide web ui.
> Angular Web UI.
![hertzBeat](https://cdn.jsdelivr.net/gh/dromara/hertzbeat/home/static/img/docs/hertzbeat-stru-en.svg)
![hertzBeat](https://cdn.jsdelivr.net/gh/dromara/hertzbeat/home/static/img/docs/hertzbeat-arch.svg)
13 changes: 0 additions & 13 deletions home/docs/others/design.md

This file was deleted.

4 changes: 1 addition & 3 deletions home/docs/others/developer.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,15 +25,13 @@ sidebar_label: Contributors
</tr>
</tbody>
</table>

<img alt="cert" src="/img/docs/cert-committer.png" width="400"/>



## ✨ HertzBeat Contributors

Thanks to these wonderful people, welcome to join us: [Contributor Guide](contributing)

<img alt="cert" src="/img/docs/cert-contributor.png" width="400"/>

<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
<!-- prettier-ignore-start -->
Expand Down
2 changes: 0 additions & 2 deletions home/docs/others/images-deploy.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,6 @@ sidebar_label: HertzBeat 华为云镜像部署快速指引
> 易用友好的开源实时监控告警工具,无需Agent,强大自定义监控能力。
[![discord](https://img.shields.io/badge/chat-on%20discord-brightgreen)](https://discord.gg/Fb6M73htGr)
[![Gitter](https://badges.gitter.im/hertzbeat/community.svg)](https://gitter.im/hertzbeat/community?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge)
[![QQ](https://img.shields.io/badge/qq-236915833-orange)](https://jq.qq.com/?_wv=1027&k=aVIVB2K9)
![hertzbeat](https://cdn.jsdelivr.net/gh/dromara/hertzbeat@gh-pages/img/badge/web-monitor.svg)
![hertzbeat](https://cdn.jsdelivr.net/gh/dromara/hertzbeat@gh-pages/img/badge/ping-connect.svg)
Expand All @@ -32,7 +31,6 @@ sidebar_label: HertzBeat 华为云镜像部署快速指引
> 您相信只需配置下就能立刻适配一款`K8s``Docker`等新的监控类型吗?
> `HertzBeat`的强大自定义,多类型支持,易扩展,低耦合,希望能帮助开发者和中小团队快速搭建自有监控系统。
> 当然我们也提供了对应的 **[SAAS版本监控云](https://console.tancloud.cn)**,中小团队和个人无需再为了监控自己的网站资源,而去部署学习一套繁琐的监控系统,**[登录即可免费开始](https://console.tancloud.cn)**

----
Expand Down
57 changes: 0 additions & 57 deletions home/docs/others/media.md

This file was deleted.

16 changes: 6 additions & 10 deletions home/docs/others/resource.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,20 +4,16 @@ title: Related resources
sidebar_label: Related resources
---

## HertzBeat Introduce PDF

Download: [PDF](http://cdn.hertzbeat.com/hertzbeat.pdf)

## Icon Resources

### TanCloud-HertzBeat Logo
### HertzBeat Logo

![logo](/img/tancloud-logo.svg)
![logo](/img/hertzbeat-logo.svg)

Download: [SVG](https://gitee.com/dromara/hertzbeat/raw/master/home/static/img/tancloud-logo.svg) [JPG](https://gitee.com/dromara/hertzbeat/raw/master/home/static/img/tancloud-logo.jpg)
Download: [SVG](/img/hertzbeat-logo.svg) [PNG](/img/hertzbeat-logo.png)

### TanCloud Brand Logo
### HertzBeat Brand Logo

![logo](/img/tancloud-brand.svg)
![logo](/img/hertzbeat-brand.svg)

Download: [SVG](https://gitee.com/dromara/hertzbeat/raw/master/home/static/img/tancloud-brand.svg) [JPG](https://gitee.com/dromara/hertzbeat/raw/master/home/static/img/tancloud-brand.jpg)
Download: [SVG](/img/hertzbeat-brand.svg) [JPG](/img/hertzbeat-brand.jpg)
9 changes: 2 additions & 7 deletions home/docs/start/sslcert-practice.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,20 +12,16 @@ This article introduces how to use the hertzbeat monitoring tool to detect the v

HertzBeat is a real-time monitoring tool with powerful custom monitoring capabilities without Agent. Website monitoring, PING connectivity, port availability, database, operating system, middleware, API monitoring, threshold alarms, alarm notification (email, WeChat, Ding Ding Feishu).

**Official website: https://hertzbeat.com | https://tancloud.cn**

github: https://github.com/dromara/hertzbeat
gitee: https://gitee.com/dromara/hertzbeat

#### Install HertzBeat

1. If you don't want to install, you can use the cloud service directly [TanCloud exploration cloud console.tancloud.cn](https://console.tancloud.cn)

2. The `docker` environment can be installed with just one command
1. The `docker` environment can be installed with just one command

`docker run -d -p 1157:1157 --name hertzbeat tancloud/hertzbeat`

3. After the installation is successful, the browser can access `localhost:1157` to start, the default account password is `admin/hertzbeat`
2. After the installation is successful, the browser can access `localhost:1157` to start, the default account password is `admin/hertzbeat`

#### Monitoring SSL certificates

Expand Down Expand Up @@ -94,7 +90,6 @@ gitee: https://gitee.com/dromara/hertzbeat
For token configuration such as Dingding WeChat Feishu, please refer to the help document

https://hertzbeat.com/docs/help/alert_dingtalk
https://tancloud.cn/docs/help/alert_dingtalk

> Alarm Notification -> New Alarm Notification Policy -> Enable Notification for the Recipient Just Configured
Expand Down
56 changes: 9 additions & 47 deletions home/docusaurus.config.js
Original file line number Diff line number Diff line change
Expand Up @@ -51,19 +51,11 @@ module.exports = {
appId: 'JMM99UL1H5',
contextualSearch: true,
},
announcementBar: {
id: 'github-star',
content:
'<font style="font-size: medium; font-weight: bolder">If you like HertzBeat,</font> <a target="_blank" style="font-size: medium; font-weight: bolder" rel="noopener noreferrer" href="https://github.com/dromara/hertzbeat">star us on GitHub </a> <font style="font-size: medium; font-weight: bolder"> or </font><a target="_blank" style="font-size: medium; font-weight: bolder" rel="noopener noreferrer" href="https://gitee.com/dromara/hertzbeat">Gitee! </a>⭐️⭐️',
backgroundColor: '#7228B5',
textColor: '#fafbfc',
isCloseable: true,
},
navbar: {
title: 'HertzBeat',
logo: {
alt: 'An open source, real-time monitoring tool with custom-monitor and agentLess.',
src: '/img/tancloud-logo.svg',
src: '/img/hertzbeat-brand.svg',
},
items: [
{
Expand Down Expand Up @@ -106,16 +98,6 @@ module.exports = {
}
],
},
{
label: '开源之夏',
position: 'left',
href: 'https://summer-ospp.ac.cn/org/orgdetail/bef415f7-741e-4db8-a4ff-b3904c502471',
},
{
label: '华为云开源活动',
position: 'left',
to: '/docs/others/huaweicloud',
},
{
type: 'docsVersionDropdown',
position: 'right',
Expand All @@ -140,18 +122,10 @@ module.exports = {
{
title: 'intro',
items: [
{
label: 'use',
to: '/docs/',
},
{
label: 'quickstart',
to: '/docs/start/quickstart',
},
{
label: 'custom',
to: '/docs/advanced/extend-point',
},
{
label: 'help',
to: '/docs/help/guide',
Expand All @@ -162,21 +136,13 @@ module.exports = {
title: 'contact',
items: [
{
label: 'dromara',
href: 'https://dromara.org/',
label: 'discussion',
href: 'https://github.com/dromara/hertzbeat/discussions/',
},
{
label: 'discuss',
label: 'contact',
to: '/docs/others/contact',
},
{
label: 'team',
href: 'https://support.qq.com/products/379369/team',
},
{
label: 'tancloud',
href: 'https://tancloud.cn',
},
}
],
},
{
Expand All @@ -186,10 +152,6 @@ module.exports = {
label: 'github',
href: 'https://github.com/dromara/hertzbeat',
},
{
label: 'gitee',
href: 'https://gitee.com/dromara/hertzbeat',
},
{
label: 'relate',
to: '/docs/others/resource',
Expand All @@ -198,12 +160,12 @@ module.exports = {
},
],
logo: {
alt: 'TANCLOUD探云-易用友好的高性能监控云',
src: '/img/planet.jpg',
alt: 'HertzBeat',
src: '/img/hertzbeat-brand.svg',
href: 'https://github.com/dromara/hertzbeat',
},
copyright:
`Copyright © 2021-${new Date().getFullYear()} HertzBeat`,
`Copyright © ${new Date().getFullYear()} HertzBeat`,
},
},
presets: [
Expand Down Expand Up @@ -231,7 +193,7 @@ module.exports = {
postsPerPage: 1,
feedOptions: {
type: 'all',
copyright: `Copyright © ${new Date().getFullYear()} TANCLOUD, Inc.`,
copyright: `Copyright © ${new Date().getFullYear()} HertzBeat.`,
},
// Please change this to your repo.
editUrl: `${repoUrl}/edit/${branch}/home/`,
Expand Down
10 changes: 5 additions & 5 deletions home/i18n/en/code.json
Original file line number Diff line number Diff line change
Expand Up @@ -257,13 +257,13 @@
"description": "The label used by the button on the collapsible TOC component"
},
"convenient-content": {
"message": "{docker} {br} [Monitoring+Alarm+Notification] all in one. Support monitoring web service, database, os, middleware, cloud-native, network and more. {br} Easy to use and agentless, offering full web-based operations for monitoring and alerting with just a few clicks. {br} Security is the most important, we encrypt the whole data of account and monitoring."
"message": "{docker} {br} Monitoring-alarm-notify all in one. Support monitoring web service, database, cache, os, web-server, middleware, bigdata, cloud-native, network etc. {br} Easy to use and agentless, full web-based operations with just a click of a mouse. {br} Security is the most important, encrypt the whole secret data."
},
"custom-multi-support-content": {
"message": "Makes protocols such as Http, Jmx, Ssh, Snmp, Jdbc configurable, allowing you to collect any metrics by simply configuring the template online. {br} High performance, supports horizontal expansion of multi-collector clusters, multi-isolated network monitoring and cloud-edge collaboration. {br} Provides flexible alarm threshold rules and timely notifications delivered via Discord Slack Telegram Email DingDing WeChat FeiShu Webhook SMS."
"message": "Makes protocols such as Http, Jmx, Ssh, Snmp, Jdbc configurable, you can collect any metrics by simply configuring the yml online. {br} High performance, supports horizontal expansion of multi-collector clusters, multi-isolated network monitoring and cloud-edge collaboration. {br} Flexible threshold rules and timely notifications delivered via discord slack email webhook more."
},
"opensource-content": {
"message": "HertzBeat's stand-alone and cluster version code are all open source, unlimited and anyone who are interested in it are very welcome to contribute. No matter how small the contribution is, whether it is a document code or a typo, we respect everyone and learn and grow together. {br} We hope that the code we participate in can be deployed to thousands of machines, leaving our code footprints in this world.{br}{github} {gitee}"
"message": "HertzBeat's stand-alone and cluster version code are all open source, unlimited and anyone who are interested in it are very welcome to contribute. No matter how small the contribution is, whether it is a document code or a typo, we respect everyone and learn and grow together. {br} Hope that the code we participate in can be deployed to thousands of machines in this world.{github}"
},
"slogan": {
"message": "Open Source Real-time Monitoring System"
Expand All @@ -272,7 +272,7 @@
"message": "Who uses HertzBeat?"
},
"Dromara Friends": {
"message": "Dromara Friends"
"message": "Friends"
},
"Friends Link": {
"message": "Friends Link"
Expand Down Expand Up @@ -470,7 +470,7 @@
"message": "We will grow better with your support and is our greatest motivation."
},
"quickstart": {
"message": "Quick Start"
"message": "Quickstart"
},
"Support HertzBeat": {
"message": "Support HertzBeat"
Expand Down
Loading

0 comments on commit f8190c4

Please sign in to comment.