Skip to content

fix(monitor): complete the missing help links in the monitoring template - #4389

Open
P-Peaceful wants to merge 3 commits into
apache:masterfrom
P-Peaceful:fix-monitor-help-link
Open

P-Peaceful wants to merge 3 commits into
apache:masterfrom
P-Peaceful:fix-monitor-help-link

Conversation

@P-Peaceful

Copy link
Copy Markdown
Contributor

What's changed?

  • Added missing helpLink entries to 11 monitoring templates:
    • Dahua
    • DNS
    • Hikvision ISAPI
    • Memcached
    • Modbus
    • NTP
    • Registry
    • S7
    • SMTP
    • Uniview
    • WebSocket
  • Added localized help links for both Chinese and English documentation.
  • The S7 monitoring documentation is not available yet. It will be completed and submitted in a follow-up PR.
  • This allows users to access the corresponding monitoring documentation directly from the monitoring configuration interface.

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.

Testing

Not run. This is a configuration-only change that adds documentation links to monitoring templates.

Follow-up

The S7 monitoring help documentation is currently unavailable. I will add the missing S7 documentation in a subsequent PR.

@utafrali utafrali left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Straightforward config-only change that adds missing helpLink entries to 11 monitoring templates, consistently following the existing zh-CN/en-US-only pattern seen in templates like app-linux.yml. The only concern is the S7 link pointing to documentation that doesn't exist yet.

en-US: HertzBeat collects metrics related to maintaining registers and coils for services that support s7 protocol
zh-TW: HertzBeat對支持s7協定的服務進行(保持寄存器和線圈)相關名額進行採集
ja-JP: HertzBeatはs7プロトコルをサポートするサービスのメトリクスを監視します。
helpLink:

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The S7 help documentation doesn't exist yet (acknowledged in the PR description), so both URLs here will return 404 until the follow-up PR lands. A dead link is a worse user experience than no link at all. Consider one of these approaches:

  1. Drop the helpLink block from this file now and add it in the same PR that ships the S7 docs.
  2. Or, if the docs page already exists in draft/stub form, verify the URLs resolve before merging.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ok, i willed delete this helpLinke

@P-Peaceful
P-Peaceful requested a review from utafrali September 21, 2026 18:41

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants