Skip to content

docs: restore Scarf gateway disclosure (FB-1354)#30

Open
dig-whois wants to merge 1 commit into
mainfrom
fb-1354-scarf-v2
Open

docs: restore Scarf gateway disclosure (FB-1354)#30
dig-whois wants to merge 1 commit into
mainfrom
fb-1354-scarf-v2

Conversation

@dig-whois

@dig-whois dig-whois commented Jul 14, 2026

Copy link
Copy Markdown
Contributor

Summary

  • restore Scarf download/company badges and the README pixel
  • advertise the Firebolt-owned OCI gateway for published chart pulls
  • document the metadata visible to Scarf, source-IP handling, and the direct-GHCR opt-out

Test plan

  • helm lint helm
  • make docs-check

DNS for oci.firebolt.io and px.firebolt.io is intentionally unchanged.


Note

Low Risk
Markdown-only changes with no chart, runtime, or credential-handling code paths affected.

Overview
Restores Scarf visibility and disclosure for published Helm chart pulls: README Downloads/Companies badges, a Telemetry section, and a 1×1 px.firebolt.io pixel on the README.

Primary install path is documented as oci://oci.firebolt.io/firebolt-db/helm-charts (Scarf gateway → GHCR), with explicit wording on what metadata Scarf sees (chart version/platform, source IP handling) and what it does not receive (values, secrets, query/app data). Direct GHCR opt-out remains documented.

docs/quickstart.mdx aligns the install note with the same expanded Scarf/gateway disclosure.

Reviewed by Cursor Bugbot for commit dd5f174. Bugbot is set up for automated code reviews on this repo. Configure here.

Advertise the Firebolt-owned gateway and badges while documenting exactly what download metadata is visible and how users can bypass Scarf.
@fireboltdb-docs-integration

fireboltdb-docs-integration Bot commented Jul 14, 2026

Copy link
Copy Markdown

Mintlify docs preview

Docs were aggregated into the Firebolt documentation site.

Status Preview Updated (UTC)
🟢 Ready View Preview Jul 14, 2026, 11:08 AM

Mintlify may take a few minutes to finish building. This comment updates on each sync while the source PR is open.

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.

2 participants