[doc] add Redis Sentinel and Apache Kvrocks monitoring help documentation - #4371

Thanks for adding the missing help pages. I checked the Sentinel parameter table against app-redis_sentinel.yml and RedisCommonCollectImpl. Please correct these in both the English and Chinese pages:

1. Line 19 describes Pattern as an optional regular expression for filtering INFO output. The template defines a required numeric mode with default 2, and the collector uses it to choose the connection mode, not as a regex filter. Please describe it as the internal Sentinel mode/default, or omit it from the user-facing parameter table since it is hidden.
2. Line 23 lists the SSH timeout default as 60000 ms, but the template sets sshTimeout to 6000 ms. Please align the documentation with that default.

After updating, please validate the documentation build and the English/Chinese help links. DOC CI and the license workflow are currently awaiting maintainer approval, so there is no CI build result yet. These findings are from source comparison; I have not run the site locally.

Hi @zqr10159, thanks for the thorough review!

I have updated both the English and Chinese documentation pages:

1. Pattern parameter: Omitted Pattern from the user-facing configuration table in both docs since it is an internal mode parameter defined as hide: true with a default of 2.
2. SSH Timeout: Aligned SSH Timeout(ms) default to 6000ms (and 6000 毫秒 in Chinese) to match sshTimeout in app-redis_sentinel.yml.

Local Validation

• Filename check: python ./script/ci/docs/check_file_name.py ./script/ci/docs/check_file_name.json → Passed.
• Markdown lint: pnpm run md-lint → Passed (571 files checked, 0 errors).
• Site build: Ran pnpm run build locally → Built successfully for all locales (en, zh-cn, ko) with no broken links or markdown link errors.
• Help routes: Verified /docs/help/redis_sentinel and /docs/help/kvrocks routes match the helpLink values in app-redis_sentinel.yml and app-kvrocks.yml.

Please take another look when you have a moment. Thanks!

Thanks for the update. I rechecked 202ab98: Pattern is omitted and the SSH timeout is 6000 ms in both the English and Chinese Sentinel pages. Those two points are fixed.

There is still a P2 concern with the help routes. In home/docusaurus.config.js, lastVersion is '1.8.0' and current only overrides the label, not the path:

With Docusaurus's version routing, this puts current docs under /docs/next/, while /docs/ belongs to 1.8.0. This PR adds the pages only to home/docs and the Chinese current directory; neither 1.8.0 help directory contains redis_sentinel.md or kvrocks.md, and the PR adds no redirects for them. The templates still point to the unversioned URLs. Based on the source, I would therefore expect the new pages at /docs/next/help/{redis_sentinel,kvrocks} and /zh-cn/docs/next/help/{redis_sentinel,kvrocks}, rather than the console's existing destinations.

Could you please serve the production build and check these four exact helpLink URLs, confirming that each renders the intended help page rather than a 404?

• https://hertzbeat.apache.org/docs/help/redis_sentinel
• https://hertzbeat.apache.org/zh-cn/docs/help/redis_sentinel
• https://hertzbeat.apache.org/docs/help/kvrocks
• https://hertzbeat.apache.org/zh-cn/docs/help/kvrocks

For local validation, replace only the origin with the local server address and keep those paths unchanged. A successful docs build alone may not catch URLs supplied by the application YAML. If the mismatch is confirmed, please add the pages to the default version, provide redirects, or align the helpLink values with the generated routes.

This is a source-based finding; I have not independently built or served the site.

Hi @zqr10159, good catch! Thank you for pointing out the Docusaurus version routing behavior with lastVersion: '1.8.0'.

You were completely right: because 1.8.0 is the default release version mapped to /docs/ and current maps to /docs/next/, adding the pages only under current resulted in the unversioned console URLs 404ing.

To align with how versioned docs and sidebars are maintained across the project (similar to PR #4113 and #4112):

1. Added redis_sentinel.md and kvrocks.md to home/versioned_docs/version-1.8.0/help/ (English).
2. Added redis_sentinel.md and kvrocks.md to home/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.8.0/help/ (Chinese).
3. Registered both entries under the cache category in home/versioned_sidebars/version-1.8.0-sidebars.json.

Local Validation

• Filename check: python ./script/ci/docs/check_file_name.py ./script/ci/docs/check_file_name.json -> Passed.
• Markdown lint: pnpm run md-lint -> Passed (571 files checked, 0 errors).
• Production build: pnpm run build -> Completed successfully for all locales (en, zh-cn, ko).
• Route check with pnpm run serve: Served the production build and verified that all 4 exact URLs return 200 OK and render the intended pages:
  • http://localhost:3000/docs/help/redis_sentinel (200 OK)
  • http://localhost:3000/zh-cn/docs/help/redis_sentinel (200 OK)
  • http://localhost:3000/docs/help/kvrocks (200 OK)
  • http://localhost:3000/zh-cn/docs/help/kvrocks (200 OK)

Please take another look when you have a moment. Thanks!