temporalio/cli

Create an index of environment variables for the docs site

Geschlossen

#697 geöffnet am 21.10.2024

Auf GitHub ansehenContributor Guide
 (1 Kommentar) (0 Reaktionen) (0 zugewiesene Personen)Go (96 Forks)auto 404
enhancementgood first issue

Repository-Metriken

Stars
 (370 Sterne)
PR-Merge-Metriken
 (PR-Metriken ausstehend)

Beschreibung

The code generation we do for the docs site should also generate an index of environment variables similar to: https://docs.temporal.io/cli#environment-variables

Contributor Guide

Research-Richtung
Untersuche die vorhandene Dokumentationscodegenerierung im Repository, um zu verstehen, wie die CLI Dokumentation erstellt wird. Suche nach Mustern, die dem Umgebungsvariablen Index unter https://docs.temporal.io/cli#environment variables ähneln. Füge dann eine ähnliche Generierung für Umgebungsvariablen hinzu.
Tech Stack
go
Domain
documentation
Issue Type
Dokumentation
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
2
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
1-3 Stunden
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
Aktiv
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Klar
Voraussetzungen
GitGo basics
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
70