Skip to content

Commit 2016b18

Browse files
zhehenluyuluo-yxDuansg
authored
[docs]doc: fix typos and grammar in docs and AccountController (#4072)
Signed-off-by: Duansg <siguoduan@gmail.com> Co-authored-by: shown <yuluo08290126@gmail.com> Co-authored-by: Duansg <siguoduan@gmail.com>
1 parent 0297f0d commit 2016b18

21 files changed

Lines changed: 30 additions & 29 deletions

File tree

hertzbeat-ai/src/main/resources/prompt/system-message.st

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -196,7 +196,7 @@ CRITICAL WORKFLOW Do all of this iteratively with user interaction at each step:
196196
- Provide clear explanations of monitoring data and actionable insights
197197
198198
## Avoid these common errors:
199-
- Using Label name instead of the value from the heirarchy JSON while creating alert rules.
199+
- Using Label name instead of the value from the hierarchy JSON while creating alert rules.
200200
- Inside the field parameters expression using '&&' instead of 'and', using '||' instead of 'or' for logical operators
201201
- This process is to trigger alarms, when certain rule or set of rules exceed a threshold value.
202202
So when a user says that the threshold should be less than 1000. the operator used should be '>' not '<',

home/blog/2024-07-27-new-committer.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,11 +17,12 @@ I have been working as a Java back-end developer for three years. At present, I
1717

1818
## First met Apache HertzBeat
1919

20-
Reading code and design in open-source framework is one way for me to improve myself. One day a thought came to my mind, which is to contribute to open-source community. Then I met HertzBeat in an article on the internel, which is completely different from Prometheus and Skywalking that I had known before. HertzBeat fascinate me with its feature, agentless and anyone can custom monitoring by monifying yaml. I forked HertzBeat on GitHub and tried to run it locally for further study.
20+
Reading code and design in open-source framework is one way for me to improve myself. One day a thought came to my mind, which is to contribute to open-source community. Then I met HertzBeat in an article on the internet, which is completely different from Prometheus and Skywalking that I had known before. HertzBeat fascinated me with its feature, agentless and anyone can custom monitoring by modifying yaml. I forked HertzBeat on GitHub and tried to run it locally for further study.
2121

2222
## My first PR
2323

24-
I failed to start HertzBeat when I followed instructions in CONTRIBUTING. The exception shows that Node.js version at lease 18 is required. Therefor I modified CONTRIBUTING and opened my first PR in HertzBeat community.
24+
I failed to start HertzBeat when I followed instructions in CONTRIBUTING. The exception shows that Node.js version at least 18 is required. Therefore I modified CONTRIBUTING and opened my first PR in HertzBeat community.
25+
2526

2627
## Keep active in community
2728

home/docs/start/docker-deploy.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ It is necessary to have Docker environment in your environment. If not installed
3131
3232
- `docker run -d` : Run a container in the background via Docker
3333
- `-p 1157:1157 -p 1158:1158` : Mapping container ports to the host, 1157 is web-ui port, 1158 is cluster port.
34-
- `-v $(pwd)/data:/opt/hertzbeat/data` : (optional, data persistence) Important, Mount the H2 database file to the local host, to ensure that the data is not lost due creating or deleting container.
34+
- `-v $(pwd)/data:/opt/hertzbeat/data` : (optional, data persistence) Important, Mount the H2 database file to the local host, to ensure that the data is not lost due to creating or deleting container.
3535
- `-v $(pwd)/logs:/opt/hertzbeat/logs` : (optional) Mount the log file to the local host to facilitate viewing.
3636
- `-v $(pwd)/application.yml:/opt/hertzbeat/config/application.yml` : (optional) Mount the configuration file to the container (please ensure that the file exists locally). [Download](https://github.com/apache/hertzbeat/raw/master/script/application.yml)
3737
- `-v $(pwd)/sureness.yml:/opt/hertzbeat/config/sureness.yml` : (optional) Mount the account configuration file to the container (please ensure that the file exists locally). [Download](https://github.com/apache/hertzbeat/raw/master/script/sureness.yml)

home/docs/start/mysql-change.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ title: Use MYSQL Replace H2 Database to Store Metadata(Optional)
44
sidebar_label: Meta Store MYSQL
55
---
66

7-
MYSQL is a reliable relational database. In addition to default built-in H2 database, Apache HertzBeat™ allow you to use MYSQL to store structured relational data such as monitoring information, alarm information and configuration information.
7+
MySQL is a reliable relational database. In addition to default built-in H2 database, Apache HertzBeat™ allows you to use MySQL to store structured relational data such as monitoring information, alarm information and configuration information.
88

99
> If you already have a MySQL environment and the MySQL version meets the requirements, you can skip directly to the database creation step.
1010

home/docs/start/postgresql-change.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,9 @@ title: Use PostgreSQL Replace H2 Database to Store Metadata(Recommended)
44
sidebar_label: Meta Store PostgreSQL (Recommended)
55
---
66

7-
PostgreSQL is a RDBMS emphasizing extensibility and SQL compliance. In addition to default built-in H2 database, Apache HertzBeat™ allow you to use PostgreSQL to store structured relational data such as monitoring information, alarm information and configuration information.
7+
PostgreSQL is an RDBMS emphasizing extensibility and SQL compliance. In addition to default built-in H2 database, Apache HertzBeat™ allows you to use PostgreSQL to store structured relational data such as monitoring information, alarm information and configuration information.
88

9-
> If you have the PostgreSQL environment, can be directly to database creation step.
9+
> If you have a PostgreSQL environment, you can skip directly to the database creation step.
1010
1111
### Install PostgreSQL via Docker
1212

home/docs/start/victoria-metrics-init.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ VictoriaMetrics is a fast, cost-effective and scalable monitoring solution and t
1313
**Note⚠️ Time series database is optional, but production environment configuration is strongly recommended to provide more complete historical chart functions and high performance**
1414
**⚠️ If you do not configure a time series database, only the last hour of historical data is retained.**
1515

16-
> If you already have an VictoriaMetrics environment, you can skip directly to the YML configuration step.
16+
> If you already have a VictoriaMetrics environment, you can skip directly to the YML configuration step.
1717
1818
### Install VictoriaMetrics via Docker
1919

home/versioned_docs/version-1.6.x/start/docker-deploy.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ It is necessary to have Docker environment in your environment. If not installed
3131
3232
- `docker run -d` : Run a container in the background via Docker
3333
- `-p 1157:1157 -p 1158:1158` : Mapping container ports to the host, 1157 is web-ui port, 1158 is cluster port.
34-
- `-v $(pwd)/data:/opt/hertzbeat/data` : (optional, data persistence) Important, Mount the H2 database file to the local host, to ensure that the data is not lost due creating or deleting container.
34+
- `-v $(pwd)/data:/opt/hertzbeat/data` : (optional, data persistence) Important, Mount the H2 database file to the local host, to ensure that the data is not lost due to creating or deleting container.
3535
- `-v $(pwd)/logs:/opt/hertzbeat/logs` : (optional) Mount the log file to the local host to facilitate viewing.
3636
- `-v $(pwd)/application.yml:/opt/hertzbeat/config/application.yml` : (optional) Mount the configuration file to the container (please ensure that the file exists locally). [Download](https://github.com/apache/hertzbeat/raw/master/script/application.yml)
3737
- `-v $(pwd)/sureness.yml:/opt/hertzbeat/config/sureness.yml` : (optional) Mount the account configuration file to the container (please ensure that the file exists locally). [Download](https://github.com/apache/hertzbeat/raw/master/script/sureness.yml)

home/versioned_docs/version-1.6.x/start/mysql-change.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ title: Use MYSQL Replace H2 Database to Store Metadata(Optional)
44
sidebar_label: Meta Store MYSQL
55
---
66

7-
MYSQL is a reliable relational database. In addition to default built-in H2 database, Apache HertzBeat allow you to use MYSQL to store structured relational data such as monitoring information, alarm information and configuration information.
7+
MySQL is a reliable relational database. In addition to default built-in H2 database, Apache HertzBeat allows you to use MySQL to store structured relational data such as monitoring information, alarm information and configuration information.
88

99
> If you already have a MySQL environment and the MySQL version meets the requirements, you can skip directly to the database creation step.
1010

home/versioned_docs/version-1.6.x/start/postgresql-change.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,9 @@ title: Use PostgreSQL Replace H2 Database to Store Metadata(Recommended)
44
sidebar_label: Meta Store PostgreSQL (Recommended)
55
---
66

7-
PostgreSQL is a RDBMS emphasizing extensibility and SQL compliance. In addition to default built-in H2 database, Apache HertzBeat allow you to use PostgreSQL to store structured relational data such as monitoring information, alarm information and configuration information.
7+
PostgreSQL is an RDBMS emphasizing extensibility and SQL compliance. In addition to default built-in H2 database, Apache HertzBeat allows you to use PostgreSQL to store structured relational data such as monitoring information, alarm information and configuration information.
88

9-
> If you have the PostgreSQL environment, can be directly to database creation step.
9+
> If you have a PostgreSQL environment, you can skip directly to the database creation step.
1010
1111
### Install PostgreSQL via Docker
1212

home/versioned_docs/version-1.6.x/start/victoria-metrics-init.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ VictoriaMetrics is a fast, cost-effective and scalable monitoring solution and t
1313
**Note⚠️ Time series database is optional, but production environment configuration is strongly recommended to provide more complete historical chart functions and high performance**
1414
**⚠️ If you do not configure a time series database, only the last hour of historical data is retained.**
1515

16-
> If you already have an VictoriaMetrics environment, you can skip directly to the YML configuration step.
16+
> If you already have a VictoriaMetrics environment, you can skip directly to the YML configuration step.
1717
1818
### Install VictoriaMetrics via Docker
1919

0 commit comments

Comments
 (0)