Skip to content

docs(concepts): add What Flox collects page - #107

Merged
stephenyeargin merged 1 commit into
mainfrom
daniel/data-collection-page
Oct 27, 2026
Merged

stephenyeargin merged 1 commit into
mainfrom
daniel/data-collection-page

Conversation

@djsauble

@djsauble djsauble commented Oct 3, 2026 •

Copy link
Copy Markdown
Contributor

Summary

This PR adds concepts/data-collection.mdx ("What Flox collects"), published at https://flox.dev/docs/concepts/data-collection. It's a short page for a developer, platform lead or privacy reviewer:

  • a four-point summary at the top, so most readers can stop there
  • what the CLI, its install script and FloxHub collect, what is linked to your account, and retention, in general terms
  • how to turn telemetry off, confirm it, and enforce it at the network edge
  • what turning telemetry off doesn't stop
  • self-hosted FloxHub, data requests and deletion, and links to the privacy policy and compliance page

The page describes behavior without listing every field, file, header or interval, so it doesn't go stale when those change. For account data and the FloxHub website, it defers to the privacy policy.

The page describes the current release (Flox 1.18.0) and names no version. #108 covers the behavior after the open flox/flox telemetry PRs ship.

Other changes

  • concepts/authentication.mdx
    • Replaces the sign-in command list with a rule (commands that resolve packages need sign-in) and a "Sign-in today" / "After the change" table.
    • Fixes two false statements: that a committed lockfile never calls the catalog, and that every command prompts you to sign in.
    • Adds ## Who on your team needs an account and four FAQ entries that link to the new page.
  • concepts/floxhub.mdx: replaces the network table with the complete list of hosts that Flox and its tools contact.
  • imageless-kubernetes/config.mdx: rewrites the telemetry section. It corrects FLOX_DISABLE_METRICS=1 to true, because 1 makes Flox commands exit with an error. It also says what the flox.dev/disable-metrics annotation covers.
  • docs.json: adds the page after concepts/authentication.
  • llms.txt: regenerated with ./scripts/generate-llms-txt.sh.
  • styles/config/vocabularies/Flox/accept.txt: adds hostname and lookups.

Merge blockers

  • Sign-in change. The switchover is today, 2026-10-20. The authentication page's "Sign-in today" / "After the change" table and the "After the change" wording need to describe the change as done before this PR merges.
  • Public by default. The page and the authentication FAQ say that FloxHub makes environments you push public by default. Confirm that this can be published.
  • Retention. Confirm the three retention statements: Flox keeps telemetry and catalog request records indefinitely, keeps pushed manifests and lockfiles after you delete the environment, and lets error reports expire automatically.
  • Deletion. The privacy team confirms "Data requests and deletion", including what deleting your account doesn't delete.
  • Privacy policy. The page now points to the privacy policy for account data and the FloxHub website. The privacy-policy PR (private repository) must cover the services Flox shares account details with, and the analytics and advertising tools on the FloxHub website and sign-in pages.

Notes for reviewers

Tests

Check Result
vale on the four changed pages 0 errors, 0 warnings, 0 suggestions
./scripts/generate-llms-txt.sh Regenerated; one line differs, for the new description
mint broken-links --check-anchors on a copy of this branch, with AGENTS.md in .mintignore 13 hits in 12 files, identical to origin/main. This PR adds none.

Not run: mint dev or a visual review of the rendered pages, and any flox command.

🤖 Generated with Claude Code

@mintlify

mintlify Bot commented Oct 3, 2026 •

Copy link
Copy Markdown

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated
flox 🟢 Ready View Preview Oct 20, 2026, 5:14 PM

💡 Tip: Enable Automations to automatically generate PRs for you.

Comment thread concepts/authentication.mdx Outdated
Comment thread concepts/authentication.mdx Outdated
Comment thread concepts/authentication.mdx Outdated
Add concepts/data-collection.mdx, a short page that says what the Flox
CLI and FloxHub collect, what is linked to an account, how long Flox
keeps it, how to turn telemetry off and enforce that, what turning it
off doesn't stop, and how to request or delete your data. It opens with
a four-point summary and describes behavior in general terms, without
listing every field, file and interval.

Correct the authentication page's sign-in list, the claim that a
committed lockfile never calls the catalog, and the claim that every
command prompts for sign-in. Add a section on who needs an account and
four FAQ entries that link to the new page.

Replace the FloxHub network table with the complete host list, and
rewrite the Imageless Kubernetes telemetry section, including the
FLOX_DISABLE_METRICS value, which accepts only true or false.

Add hostname and lookups to the Vale vocabulary.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@stephenyeargin
stephenyeargin added this pull request to the merge queue Oct 27, 2026
Merged via the queue into main with commit cd5cf7a Oct 27, 2026
6 checks passed
@stephenyeargin
stephenyeargin deleted the daniel/data-collection-page branch October 27, 2026 14:19

This branch was successfully deployed

1 active deployment
staging — 804eeb18 Deployed Oct 20, 2026 by mintlify[bot]
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants