Altinity / Altinity/altinity-sql-browser

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

Ouverte
#71 3 commentaires 0 réactions 0 personnes assignées Voir sur GitHub

Personne n'a encore pris cette issue.

documentation
Langage dominant
TypeScript
Étoiles
8
Forks
2
Merge moyen
1 h 34 min
PR mergées (30 j)
6

Description

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.

Guide de contribution

Ouvrir le guide de contribution

Par où commencer

  1. Lisez l'issue en entier, puis le guide de contribution du projet.
  2. Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
  3. Forkez le dépôt et travaillez sur une branche.
  4. Ouvrez une pull request qui référence le numéro de l'issue.

Piste de recherche

Commencez par README et examinez SECURITY.md, les issues associés à WebKit/Safari et au zoom, ainsi que #627 pour la décision de compatibilité avec ClickHouse 24.8. Documentez la matrice des navigateurs, l’orientation desktop uniquement, la prise en charge et les limitations de ClickHouse, ainsi que les exigences de l’IdP, en veillant à ce que la ligne Safari corresponde à la décision concernant WebKit.

Rédigé par le modèle d'indexation à partir du texte de l'issue.

Évaluation

Stack technique
clickhouse
Domaine
documentation
Type d'issue
Documentation
Difficulté
3/5
Temps estimé
1-2 jours
Activité
Calme
Clarté
Plutôt claire
Accessibilité débutants
55/100

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.