You are viewing a plain text version of this content. The canonical link for it is here.
Posted to notifications@hertzbeat.apache.org by "butterfly-520-boy (via GitHub)" <gi...@apache.org> on 2026/10/01 10:09:35 UTC
[PR] [doc] add HertzBeat monitoring help documentation [hertzbeat]
butterfly-520-boy opened a new pull request, #4413:
URL: https://github.com/apache/hertzbeat/pull/4413
## What's changed?
- Add English help documentation for the `app-hertzbeat` monitoring template.
- Add the corresponding Chinese help documentation.
- Register `help/hertzbeat` in the Custom section of the documentation sidebar.
- Document the connection parameters and the Summary, Inner Queue, Threads, and Memory Used metric sets.
Related to #1795.
## Validation
- `pnpm exec markdownlint-cli2 --config ../.markdownlint-cli2.jsonc "docs/help/hertzbeat.md" "i18n/zh-cn/docusaurus-plugin-content-docs/current/help/hertzbeat.md"`
- `pnpm build` (English, Chinese, and Korean locales)
## Checklist
- [x] I have read the Contributing Guide.
- [x] I have written the necessary documentation.
- [x] Unit tests are not applicable to this documentation-only change; Markdown lint and the full documentation build pass.
## Add or update API
- [x] No API changes.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@hertzbeat.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: notifications-unsubscribe@hertzbeat.apache.org
For additional commands, e-mail: notifications-help@hertzbeat.apache.org
Re: [PR] [doc] add HertzBeat monitoring help documentation [hertzbeat]
Posted by "tomsun28 (via GitHub)" <gi...@apache.org>.
tomsun28 merged PR #4413:
URL: https://github.com/apache/hertzbeat/pull/4413
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@hertzbeat.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: notifications-unsubscribe@hertzbeat.apache.org
For additional commands, e-mail: notifications-help@hertzbeat.apache.org
Re: [PR] [doc] add HertzBeat monitoring help documentation [hertzbeat]
Posted by "butterfly-520-boy (via GitHub)" <gi...@apache.org>.
butterfly-520-boy commented on PR #4413:
URL: https://github.com/apache/hertzbeat/pull/4413#issuecomment-5956419430
Thank you for the review and approval.
I investigated the failed `docs-build` job. The failure comes from the repository-wide Dead Link Check on pre-existing external links:
- `https://github.com/DavidAnson/markdownlint/blob/main/doc/Rules.md` returned HTTP 503.
- `https://docs.taosdata.com/3.4.1/reference/components/taoskeeper/` returned HTTP 404 in existing TDengine documentation.
The two new `hertzbeat.md` files contain no hyperlinks and both pass `markdown-link-check@3.8.7` with exit code 0. Markdown lint and the full Docusaurus build for all locales also pass locally.
Could a maintainer please rerun the check or advise whether this unrelated failure can be ignored for this documentation PR? Thanks.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@hertzbeat.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: notifications-unsubscribe@hertzbeat.apache.org
For additional commands, e-mail: notifications-help@hertzbeat.apache.org