Altinity / Altinity/altinity-sql-browser

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

Đang mở
#71 3 bình luận 0 reaction 0 người được giao Xem trên GitHub

Chưa có ai nhận issue này.

documentation
Ngôn ngữ chính
TypeScript
Star
8
Fork
2
Merge trung bình
1 giờ 34 phút
Pull request đã merge (30 ngày)
6

Mô tả

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.

Hướng dẫn đóng góp

Mở hướng dẫn đóng góp

Bắt đầu từ đâu

  1. Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
  2. Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
  3. Fork repository và làm thay đổi trên một nhánh.
  4. Mở pull request có tham chiếu số hiệu của issue.

Hướng nghiên cứu

Bắt đầu với README và xem lại SECURITY.md, các issue liên quan đến WebKit/Safari và zoom, cùng #627 để biết quyết định về khả năng tương thích với ClickHouse 24.8. Ghi lại ma trận trình duyệt, định hướng chỉ dành cho desktop, khả năng hỗ trợ và các giới hạn của ClickHouse, cùng các yêu cầu của IdP, trong đó dòng Safari phải phù hợp với quyết định về WebKit.

Do mô hình lập chỉ mục viết ra từ nội dung của issue.

Đánh giá

Công nghệ
clickhouse
Lĩnh vực
documentation
Loại issue
Tài liệu
Độ khó
3/5
Thời gian dự kiến
1-2 ngày
Mức độ hoạt động
Ít trao đổi
Độ rõ ràng
Khá rõ ràng
Mức phù hợp với người mới
55/100

Nhận issue mới trong hộp thư của bạn

Bản tóm tắt ngắn những issue GitHub phù hợp với người mới.