Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Grafana doc #2647

Merged
merged 13 commits into from
Sep 1, 2024
Merged

Grafana doc #2647

merged 13 commits into from
Sep 1, 2024

Conversation

zqr10159
Copy link
Member

@zqr10159 zqr10159 commented Sep 1, 2024

What's changed?

Grafana doc

Checklist

  • I have read the Contributing Guide
  • I have written the necessary doc or comment.
  • I have added the necessary unit tests and all cases have passed.

Add or update API

  • I have added the necessary e2e tests and all cases have passed.

…rationAdd Chinese documentation explaining the integration of Grafana for historical data

visualization within the HertzBeat monitoring system. The new documentation covers
prerequisites, configuration steps, and how to upload Grafana dashboard templates.
Add documentation on configuring and using the Grafana Dashboard for displaying
historical data in HertzBeat, including setup instructions and steps to upload
Grafana monitor template JSON files within the HertzBeat monitor.
Refine instructions in the grafana_dashboard.md docs for both English and Chinese
localizations. Specify changes made to indicate the correct download location of
Grafana dashboard JSON templates and correct the example link format in both
languages to ensure users can quickly and correctly follow the instructions for
uploading Grafana monitor templates in HertzBeat.

This update improves the accuracy of the documentation, making it more user-friendly
and ensuring that users can effortlessly download and utilize Grafana dashboard
templates within HertzBeat.
…a documentation

Remove the trailing hyphen in the grafana_dashboard.md to correct the documentation.
This change updates the instructions for viewing Grafana historical charts by clarifying
the steps required on the HertzBeat monitoring page: users should click the Grafana button,
select 'Grafana Historical Charts', choose a monitoring template, and then press the Query
button to access the desired charts.
```
Update the prerequisites in both English and Chinese versions of the grafana_dashboard
documentation to reflect the correct Grafana version and configuration steps. Additionally,
add a note on enabling embedding in Grafana by setting the `allow_embedding` option to
`true` in the `grafana.ini` configuration file.
@github-actions github-actions bot added the doc Improvements or additions to documentation label Sep 1, 2024
# Conflicts:
#	home/docs/help/grafana_dashboard.md
#	home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/grafana_dashboard.md
@zqr10159 zqr10159 requested a review from LiuTianyou September 1, 2024 08:17
zqr10159 and others added 5 commits September 1, 2024 16:34
Update the documentation to reflect the necessary configurations in the `grafana.ini`
file for enabling embedding and anonymous access. Also, clarify the prerequisites for
using Grafana with HertzBeat and VictoriaMetrics. The changes include specifying the
`allow_embedding` and `[auth.anonymous]` settings and correcting the formatting of the`VictoriaMetrics` database reference.
Update the documentation to reflect the necessary configurations in the `grafana.ini`
file for enabling embedding and anonymous access. Also, clarify the prerequisites for
using Grafana with HertzBeat and VictoriaMetrics. The changes include specifying the
`allow_embedding` and `[auth.anonymous]` settings and correcting the formatting of the`VictoriaMetrics` database reference.
@LiuTianyou LiuTianyou merged commit 3e1d87b into master Sep 1, 2024
3 checks passed
@zqr10159 zqr10159 deleted the grafana-doc branch September 1, 2024 11:04
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
doc Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants