docs: describe the anonymous weekly usage report in Security - #158
Merged
Conversation
The Security page said Maintainerr has no telemetry and never phones home, and listed a closed set of outbound destinations. Neither holds once the anonymous weekly usage report ships. Rewrite the locality bullet so it still says configuration and state stay on the user's hardware, add telemetry.maintainerr.info to the outbound list, and cover what the report contains and the three ways to turn it off. Add TELEMETRY to the environment variable table.
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.
docs/Security.mdclaimed "no telemetry, and no analytics - Maintainerr never phones home" and gave a closed list of outbound destinations. Both go stale when Maintainerr#3582 ships.docs/Security.mdtelemetry.maintainerr.infoalongside the configured services and the metadata providersdocs/Security.mdTELEMETRY=off). Detail is left to the collector repodocs/Installation.mdxTELEMETRYrow in the environment variable tableVersioned snapshots
Left untouched, on your call. 3.22.0, 3.22.1, 3.23.0 and 3.24.0 all still carry the old claim, and it was true for each of them: the report ships after 3.24.0, so no released version phones home. I had drafted a short forward-pointing admonition in each and reverted it.
Worth a second thought before this merges, since the report is on by default: someone running 3.24.0 reads "never phones home" on the version selector's default page, upgrades, and starts reporting. If you want that covered, the cheapest fix is a note in the 3.24.0 snapshot only, added when the release that ships telemetry is cut.
Notes
docs/API.mdanddocs/ReverseProxy.mdmentionBASE_PATHandUI_PORTin prose but carry no variable table, so there is nothing to add there. A grep ofdocs/for telemetry, analytics, phones home and outbound turns up no other stale claim.feat/telemetry-client, not the PR description:enabled()isprocess.env.TELEMETRY === 'off' ? false : telemetryEnabled !== false, and the About entry point is labelled "Help us improve it".npm run buildis clean.onBrokenLinksiswarnin this repo rather thanthrow, so I also confirmed in the built HTML that the newSecurity.md#how-maintainerr-handles-your-datalink resolves to a real anchor and stays inside the same docs version.