docs(orb): separate telemetry from token brokerage - #2661
Conversation
The GitHub App and Orb doc presented direct App and brokered Orb as symmetric, co-equal options with no risk framing, no explicit "private/managed-beta only" label on brokered mode, and no explanation that telemetry export is a completely separate concern from token brokerage -- exactly the conflation #1939 asks to resolve. - Direct App is now explicitly labeled the recommended default; brokered Orb is explicitly labeled private/managed-beta only, with a callout on why (every brokered install draws on gittensory's own GitHub API quota, not just the operator's). - New "Telemetry is separate from token brokerage" section: telemetry export is always-on in EITHER connection mode (it's what feeds the homepage counters and cross-fleet gate calibration), while brokerage is the optional, restricted piece. Documents exactly what is/isn't exported and the ORB_AIR_GAP opt-out. - New "Brokered mode operational risks" callout: rate-limit blast radius, quota management, support burden, abuse/misconfiguration risk. - New "Minimum broker safeguards before a public rollout" maintainer checklist: enrollment quota, per-install concurrency, per-install rate budget, revocation path, metrics broken out by enrollment.
|
Warning 🟨🟨🟨🟨🟨🟨🟨🟨🟨🟨🟨🟨 ⏸️ Gittensory review result - manual review recommendedReview updated: 2026-07-03 01:47:00 UTC
⏸️ Suggested Action - Manual Review
Review summary Nits — 6 non-blocking
Concerns raised — review before merging
Review context
Contributor next steps
Signal definitions
🟩 Safe / merged · 🟦 Advisory · 🟨 Held for review · 🟥 Blocked / closed 💰 Earn for open-source contributions like this. Gittensor lets GitHub contributors earn for the work they already do — register to start earning →. Checked by Gittensory, a quiet PR intelligence layer for OSS maintainers.
|
Deploying with
|
| Status | Name | Latest Commit | Preview URL | Updated (UTC) |
|---|---|---|---|---|
| ✅ Deployment successful! View logs |
gittensory-ui | fe57e17 | Commit Preview URL Branch Preview URL |
Jul 03 2026, 01:48 AM |
Gate review nit: "always on" read as contradicting the ORB_AIR_GAP opt-out documented two paragraphs later. "Enabled by default" says the same thing without the apparent contradiction.
Closes #1939
Summary
The GitHub App and Orb doc presented direct App and brokered Orb as symmetric, co-equal options with no risk framing, no explicit "private/managed-beta only" label on brokered mode, and no explanation that telemetry export is a completely separate concern from token brokerage — exactly the conflation this issue asks to resolve.
ORB_AIR_GAPopt-out.Test plan
npm run ui:typecheck,npm run ui:lint— cleannpm run test:ci(full local gate, unsharded) — greennpm audit --audit-level=moderate— 0 vulnerabilities