Skip to content

[doc] fix the release and verification guides, document native collector requirements - #4381

Merged
zqr10159 merged 5 commits into
apache:masterfrom
Duansg:doc-guide
Sep 14, 2026
Merged

zqr10159 merged 5 commits into
apache:masterfrom
Duansg:doc-guide

Conversation

@Duansg

@Duansg Duansg commented Sep 14, 2026

Copy link
Copy Markdown
Member

What's changed?

Why

Releasing 1.9.0 exposed several problems in these guides. The most costly one: the signing loop and the verification loop both matched *.tar.gz only, so the windows-amd64 native collector package went into the RC2 vote with no signature and no checksum, and neither side would have caught it.

What changed

Release guide

  • fix two commands that fail as written: the collector directory does not exist, and -pl hertzbeat-collector-collector is rejected by Maven
  • replace the personal details of two different release managers with placeholders, listed in a table at the top
  • sign *.zip too, and add a loop that reports any artifact missing a .asc or .sha512
  • add a note to start each native package once before signing it

Verification guide

  • verify *.zip too
  • add a section for the native collector packages: they cannot be built from source, so check that they start and stay up
  • rewrite the "trust the public key" section — verifying a signature does not require trust, and marking someone else's key ultimate is wrong
  • fix backticks in the download commands (the shell runs them as command substitution), a self-referencing checklist item, and a stray dash in the KEYS command

Native collector requirements

  • document AVX2, glibc 2.34 and the Windows VC++ redistributable, plus what each unmet requirement looks like — without AVX2 the process exits instantly with no output, which reads as a corrupted download
  • link to it from the 1.9.0 upgrade guide

Rendering fix

  • {version} in headings and prose was evaluated as a JS variable by MDX, so the Chinese release guide rendered only version is not defined

English and Chinese versions are kept in sync. Worth opening the pages once before merging — the MDX error is invisible in the diff.

image

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.

@Duansg
Duansg requested a review from zqr10159 September 14, 2026 04:40
@github-actions github-actions Bot added the doc Improvements or additions to documentation label Sep 14, 2026
@zqr10159
zqr10159 merged commit fa0a952 into apache:master Sep 14, 2026
3 checks passed
@Duansg
Duansg deleted the doc-guide branch September 14, 2026 07:36
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