Altinity / Altinity/altinity-sql-browser

Document the supported-browser matrix (browsers, ClickHouse versions, IdP requirements)

Aperta
#71 3 commenti 0 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

documentation
Lingua principale
TypeScript
Stelle
8
Fork
2
Merge medio
1h 34m
PR unite (30g)
6

Descrizione

Part of #68 (Roadmap to 1.0.0) — release-blocker.

Problem

The README never states which browsers/versions are supported, nor the supported ClickHouse versions or IdP requirements. A 1.0 cannot ship silent on this — especially given the html{zoom} reliance (see the zoom de-risk + WebKit-e2e issues), which makes the supported-engine set a real, non-obvious constraint.

Ask

Add a concise support matrix / system-requirements section to the README:

  • Browsers + minimum versions (desktop Chrome/Edge/Firefox; Safari status pending the WebKit decision). Note desktop-only if that's the call (no responsive CSS today).
  • ClickHouse server versions (incl. Antalya vs OSS + JWT-verify sidecar notes).
  • IdP/OAuth requirements (PKCE public client preferred; the client_secret caveat → link SECURITY.md).
Acceptance
  • README has a clear, scannable support matrix.
  • Browser row reflects the WebKit/Safari decision from the related issues.

Folded in from the roadmap (#68) nice-to-haves:

  • State the desktop-only stance explicitly — there is no responsive CSS today (no @media, fixed px, overflow:hidden on html/body). The matrix should say "desktop browsers" (or add a minimal narrow-viewport fallback) so a phone/tablet user isn't surprised by a silently-broken layout.
ClickHouse 24.8 decision (#627)

ClickHouse 24.8 is Limited support: query execution and Table results are
supported. Typed result features such as automatic charts, KPI interpretation,
logs detection, and type-aware formatting may be unavailable because 24.8 does
not provide result metadata in the streaming format used by SQL Browser.

SQL Browser does not infer ClickHouse result types from returned values.
Do not describe 24.8 as full-fidelity support. #627 is the production
compatibility implementation and live-verification record.

Guida per i contributori

Apri la guida per i contributori

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Direzione di ricerca

Inizia da README e consulta SECURITY.md, le issue correlate a WebKit/Safari e allo zoom, e #627 per la decisione sulla compatibilità con ClickHouse 24.8. Documenta la matrice dei browser, l’impostazione esclusivamente desktop, il supporto e le limitazioni di ClickHouse e i requisiti dell’IdP, facendo in modo che la riga Safari corrisponda alla decisione su WebKit.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Valutazione

Stack tecnologico
clickhouse
Ambito
documentation
Tipo di issue
Documentazione
Difficoltà
3/5
Tempo stimato
1-2 giorni
Stato di attività
Tranquilla
Chiarezza
Abbastanza chiara
Idoneità per principianti
55/100

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.