gristlabs/grist-core

Add useful diagnostics to the admin panel

Open

#867 opened on Feb 23, 2024

View on GitHub
 (3 comments) (1 reaction) (0 assignees)TypeScript (3,613 stars) (168 forks)batch import
good first issueself-hosting

Description

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
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
mostly clear
Prerequisites
TypeScriptNode.jsGrist admin panel
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
65
Research direction
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.