gristlabs/grist-core

Add useful diagnostics to the admin panel

Open

#867 geöffnet am 23. Feb. 2024

Auf GitHub ansehen
 (3 Kommentare) (1 Reaktion) (0 zugewiesene Personen)TypeScript (3.613 Stars) (168 Forks)batch import
good first issueself-hosting

Beschreibung

Grist should be easier to install. Until it is, we can at least make it easier to find out what is going wrong. There's a page coming to help with that in https://github.com/gristlabs/grist-core/pull/850. So far it is pretty bare. This issue is to collect ideas for what to add to it. Here are some to start.

Edit: the page arrived, and a set of checks are now available in the admin panel. There are more than listed below. Continuing to add more here.

From https://community.getgrist.com/t/questions-about-self-hosted-grist-and-authentik-with-oidc/5250/2

  • Show whether the anonymous playground is available, since many users might not expect that

Contributor Guide

Tech Stack
typescriptnodejsexpressreact
Domain
backendfrontenddevops
Issue Type
feature
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
3
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
half day
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
active
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
mostly clear
Voraussetzungen
TypeScriptNode.jsGrist admin panel
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
65
Research-Richtung
Start by examining the existing admin panel page introduced in PR #850. Review how the first check (document sandboxing) is implemented. Then, for each unchecked item, identify the relevant backend functionality (e.g., persistent volume, worker reachability, snapshot configuration) and implement a similar diagnostic check. Ensure checks are clear and testable. Reference the comments in #850 and #857 for additional context on snapshot health checks.