Hacktoberfest 2026: die Issues, die Maintainer für den Oktober markiert haben – offen und einsteigerfreundlich. Hacktoberfest-Issues durchsuchen

docs(runtimes): driver TOML examples omit [openshell] version = 2 and fail preflight

Offen Anfängerfreundlich
  • Stimmt etwas nicht?
#3,881 0 Kommentare 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Maintainer antworten meist innerhalb von 1 Tag

Dieses Issue hat noch niemand übernommen.

Bewertung

Schwierigkeit
1/5
Geschätzter Aufwand
1-3 Stunden
Anfängerfreundlichkeit
88/100
Issue-Typ
Dokumentation
Klarheit
Klar beschrieben
Aktivitätsstatus
Aktiv
Bereich
documentation

Rechercherichtung

Öffne docs/how-it-works/sandboxes/runtimes.mdx und vergleiche die Docker-, Podman- und MicroVM-Snippets mit dem Schema-Beispiel in configuration.mdx. Führe die dokumentierte Reproduktion mit openshell-gateway config preflight aus, falls die lokale Umgebung verfügbar ist. Die Aufgabe ist abgeschlossen, wenn jedes Beispiel in sich abgeschlossen ist und [openshell] / version = 2 enthält oder die Seite diese Anforderung vor dem ersten Beispiel klar nennt.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Beschreibung

state:triage-needed
User Story

As an operator configuring a compute driver from the Runtimes documentation, I want the TOML snippets there to be valid on their own, so that copying one into a fresh gateway.toml doesn't stop the gateway from starting.

Problem Statement

The Docker, Podman, and MicroVM sections of docs/how-it-works/sandboxes/runtimes.mdx show snippets like this:

[openshell.gateway]
compute_driver = "docker"

[openshell.drivers.docker]
socket_path = "/var/run/docker.sock"

Put into a new ~/.config/openshell/gateway.toml (the Linux package installs none), this makes the service fail at ExecStartPre=openshell-gateway config preflight:

gateway config preflight failed: ... category=missing_version detected_version=missing;
the file was preserved unchanged; migrate it before restarting the gateway

The snippets omit [openshell] / version = 2, which configuration.mdx shows but runtimes.mdx doesn't.

Impact / Why This Matters

The error tells the user to follow the schema v2 migration steps. That's confusing for someone who never had a v1 file, and it isn't obvious that the documented snippet itself is incomplete. The gateway stays down until they find the missing key.

Acceptance Criteria
  • The TOML examples in runtimes.mdx include [openshell] / version = 2, or the page states once, before the first example, that every file needs it.
  • Optional: when a file has only v2-shaped tables and no version key, the preflight message suggests adding [openshell] version = 2 rather than pointing to a migration.
Reproduction Steps
  1. Linux install with no existing ~/.config/openshell/gateway.toml.
  2. Copy the Docker driver snippet from runtimes.mdx into that file.
  3. Run openshell-gateway config preflight. It fails with missing_version.
Environment
  • OpenShell 0.1.2, gateway as a systemd user service (Debian package layout)
Vorherrschende Sprache
Rust
Sterne
8.7k
Forks
1.3k
Ø Merge
1 T. 22 Std.
Gemergte PRs (30 T.)
328

Entwicklungsumgebung

Erste Schritte

  1. Lesen Sie das ganze Issue und danach den Beitragsleitfaden des Projekts.
  2. Schreiben Sie ins Issue, dass Sie es übernehmen — das erspart doppelte Arbeit.
  3. Forken Sie das Repository und arbeiten Sie in einem Branch.
  4. Öffnen Sie einen Pull Request, der die Issue-Nummer nennt.

Mehr aus NVIDIA/OpenShell

Alle Issues in NVIDIA/OpenShell

Ähnliche Issues

Weitere Issues zu Rust

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.