docs(readme): say plainly whether OpenCompany phones home - #2154
Draft
graycyrus wants to merge 1 commit into
Draft
docs(readme): say plainly whether OpenCompany phones home#2154graycyrus wants to merge 1 commit into
graycyrus wants to merge 1 commit into
Conversation
`README.md` did not mention analytics anywhere — the only occurrence of the word was an unrelated company template. Someone evaluating a GPL-3.0, self-hostable project should not have to read `docs/spec/runtime/` to answer "does this send anything about me anywhere". Adds a short section stating the four things that matter: a self-hosted or desktop install sends nothing and cannot, because the transport is behind a cargo feature the default build does not compile (`analytics = ["dep:reqwest"]` is absent from `default` in `Cargo.toml`, `Dockerfile` ships `ARG FEATURES=""`, and `src-tauri/Cargo.toml` names it nowhere); hosted tenants report shape and outcome under an opaque id because the platform builds with the feature and injects a token; no company content can ride along, because `PropValue` has no `String` variant by construction; and `OPENCOMPANY_ANALYTICS=off` turns it off. Points at the spec for the full list, and notes that crash reporting is a separate, operator-configured channel to the operator's own Sentry project so the section is not read as covering it. Describes behaviour already on `main`; no code change.
|
Important Draft PR not reviewedDraft PRs are not automatically reviewed by default.
To automatically review draft PRs, update your CodeRabbit configuration: reviews:
auto_review:
drafts: trueComment |
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.
Summary
README.mddoes not mention analytics anywhere today — the only occurrence of the word is an unrelated marketing-agency company template.docs/spec/runtime/analytics.mdis thorough, but someone evaluating a GPL-3.0, self-hostable project should not have to readdocs/spec/runtime/to learn whether it phones home.Adds one short section, "What it reports about itself", between Make it yours and Documentation. No code change; it describes behaviour already true on
main.What it claims, and where each claim was checked
Cargo.toml:456(default = ["oauth", "platform-jwt", "documents", "tinymemory"]) andCargo.toml:621(analytics = ["dep:reqwest"]);Dockerfile:7(ARG FEATURES="");src-tauri/Cargo.tomlnamesanalyticsnowhere;src/analytics/mixpanel.rs:31,39,51gate the client on#[cfg(feature = "analytics")]TENANT_FEATURESin.github/workflows/deploy-staging.yml:110ends…,analytics,crash-reporting;OPENCOMPANY_ANALYTICS_TOKENinsrc/analytics/config.rs:16docs/spec/runtime/analytics.mddocs/spec/runtime/analytics.md:81-101, andPropValueinsrc/analytics/types.rs:48-57— `Word(&'static str)OPENCOMPANY_ANALYTICS=offturns it off and outranks everythingENABLE_ENVinsrc/analytics/config.rs:13and theSilencereasons below itThe section deliberately does not give a number for the conditions that must hold, because
docs/spec/runtime/analytics.mdcurrently says "the four conditions in full" at line 16 while the numbered list under Configuration has five. Not fixed here to keep this PR to the README; worth a follow-up.It also adds one sentence pointing at
docs/spec/runtime/crash-reporting.md, so the section is not read as covering a channel it does not describe — crash reporting is off until an operator configures a DSN, and goes to the operator's own Sentry project rather than one this project runs.Relationship to #1950
Independent of it. #1950 is the analytics instrumentation work and is currently far behind
main; this describes behaviour that is already true onmaintoday, so it is branched frommainand stands on its own.Commands run locally
bash scripts/ci/assert-md-line-cap.sh— ✓ every file 500 lines or fewer (README.mdis now 231)docs/spec/runtime/analytics.md,docs/spec/runtime/crash-reporting.mdNo Rust changed, so no
cargogate applies to this diff.