Repository navigation
Conversation
What changed: - install/_index.md: the download step gains a "Verify the download" expand block, labelled Recommended, that explains the signature and digests files and walks through importing the InfluxData package signing key, verifying both signatures with gpg, and checking the SHA-256 checksum with `sha256sum` (or `shasum` on macOS) and `Get-FileHash` on Windows, in Linux/macOS and Windows tabs. The digests filename uses the `latest-patch` shortcode. The block is wrapped in `expand-wrapper` so it stays inside the list item. - install/upgrade.md: the download step says to verify before replacing the executable and links to the block, which opens on arrival. Why: The install page offered downloads with no way to verify them, while every release ships `.asc` signatures and a signed digests file. Impact: Two existing pages; no URL or alias changes. The block's anchor is `#verify-the-download-recommended`, derived from its label. Verification: Vale (warning level): 0 errors, 0 warnings. `yarn lint-codeblocks`: no failures. Rendered with `hugo server`; the block renders inside the download step with the Install step following in the same list, and the link from the upgrade page opens it.
…ion from products.yml What changed: - layouts/shortcodes/telegraf/tc-downloads.html reads the release version from `telegraf_controller.latest_patch` in data/products.yml and keeps the build matrix in a commented block in the template. For each build it emits the binary URL and its detached signature URL (`<file>.asc`), plus the release's `telegraf_controller-<version>.digests` file and its signature. data/tc_downloads.yml is removed. - assets/js/tc-downloads.js renders, after the gate, an intro paragraph that explains the signature and checksum files, the version line once, a "Signature (.asc)" button beside each download button, and a Checksums row with the digests file and its signature. The SHA-256 text and copy-to-clipboard code are removed. After rendering, it re-scrolls to any URL hash (the rendered block shifts the page), and in-page anchor links inside the block scroll to and open their target through the site's `scrollToAnchor`. - assets/styles/layouts/article/_tc-downloads.scss drops the flex row layout and the SHA styles, pads the rows, and styles the signature link as a 1px outlined button in the download-button blue that changes color on hover. The themes gain `$article-btn-outline` and `$article-btn-outline-hover` (darker on hover in light, lighter in dark). - cypress/e2e/content/tc-downloads.cy.js asserts the signature links and the digests row instead of the copy buttons. Why: Telegraf Controller releases ship a detached PGP signature per binary and a signed SHA-256 digests file, so readers can verify downloads without a hand-copied checksum in a data file. Deriving the version from products.yml leaves one place to bump per release. Impact: Pages that use the shortcode (Controller install and upgrade). The rendered block stays behind the existing download gate. Releasing now means bumping `latest_patch` only; the signature and digests links resolve once the release files are uploaded. Verification: `node --check` and ESLint on the script and spec: clean. Rendered with `hugo server`; decoded the shortcode's data attribute and confirmed every URL, confirmed the compiled light and dark stylesheets, and confirmed the served bundle. The Cypress binary cannot start in this environment, so the spec was not executed locally.
Contributor
Vale Style Check Results
✅ Check passed |
Contributor
🔗 Link Check Results — Link Check Bot❌ 2 broken link(s) found — fix them before merging.
Broken Links
|
| Source File | URL | Issue |
|---|---|---|
content/telegraf/controller/install/_index.md |
https://support.influxdata.com/ | Network error: SSL certificate not trusted. Use --insecure if site is trusted (e… |
content/telegraf/controller/install/upgrade/_index.md |
https://support.influxdata.com/ | Network error: SSL certificate not trusted. Use --insecure if site is trusted (e… |
Full details: workflow run summary and artifact. Last updated: 2026-10-27 13:32:20 UTC
sanderson
merged commit Oct 27, 2026
18811b1
into
docs/telegraf-controller-1.2.0
21 of 22 checks passed
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What changed
Three commits on top of
docs/telegraf-controller-1.2.0.docs(controller): document how to verify downloadscontent/telegraf/controller/install/_index.md: the download step gains a "Verify the download" expand block, labelled Recommended, that explains the three files a release ships (the executable, its detached.ascsignature, and the signedtelegraf_controller-<version>.digestschecksum file) and walks through importing the InfluxData package signing key, verifying both signatures withgpg, and checking the SHA-256 withsha256sumorshasumon Linux and macOS andGet-FileHashon Windows. The digests filename comes from thelatest-patchshortcode. The block is wrapped inexpand-wrapperso it stays inside the numbered step.content/telegraf/controller/install/upgrade.md: the download step says to verify before replacing the executable and links to the block, which opens on arrival.feat(tc-downloads): add signature and digests links and read the version from products.ymllayouts/shortcodes/telegraf/tc-downloads.htmlreads the release version fromtelegraf_controller.latest_patchindata/products.ymland keeps the OS and architecture matrix in a commented block in the template. For each build it emits the binary URL and its.ascURL, plus the release's digests file and its signature.data/tc_downloads.ymlis removed.assets/js/tc-downloads.jsrenders, behind the existing gate, an intro paragraph about the signature and checksum files, the version line once, a "Signature (.asc)" button beside each download button, and a Checksums row with the digests file and its signature. The hand-copied SHA-256 text and the copy-to-clipboard code are gone. After rendering it re-scrolls to any URL hash, since the rendered block shifts the page, and in-page anchor links inside the block scroll to and open their target through the site'sscrollToAnchor.assets/styles/layouts/article/_tc-downloads.scssdrops the flex row layout and SHA styles, pads the rows, and styles the signature link as a 1px outlined button in the download-button blue. The themes gain$article-btn-outlineand$article-btn-outline-hover(darker on hover in the light theme, lighter in the dark theme).cypress/e2e/content/tc-downloads.cy.jsasserts the signature links and the digests row instead of the copy buttons.style(tc-downloads): apply Prettier quoting to the Cypress spec: a one-line change the pre-commit hook made after staging.Why
Telegraf Controller releases ship a detached PGP signature for every binary and a signed SHA-256 digests file, but the install page offered downloads with no way to verify them. Linking the signature files beside each download and documenting the verification steps closes that gap. Reading the version from
products.ymland dropping the checksum data file leaves one value to bump per release instead of a version plus five hand-pasted hashes.Impact
Two Controller pages change, with no URL or alias changes; the verification block's anchor is
#verify-the-download-recommended. The download block on the install and upgrade pages renders the new links behind the same gate as before. The download base URL is unchanged in this PR; the switch to the new release host follows once the 1.2.0 files are confirmed there.Verification
yarn lint-codeblocks: no failures.node --checkand ESLint on the script and spec: clean. Lefthook pre-commit hooks passed on each commit.hugo server: decoded the shortcode's data attribute and confirmed every binary, signature, and digests URL; confirmed the compiled light and dark stylesheets and the served bundle; confirmed the expand block renders inside the download step with the Install step following in the same list; confirmed the links open the block from the upgrade page and from within the install page.tc-downloads.cy.jswas not executed locally; CI runs it.Checklist
npx hugo --quiet)