google/dranet

Tutorials and Documentation

Open

#73 geöffnet am 9. Mai 2025

Auf GitHub ansehen
 (1 Kommentar) (0 Reaktionen) (0 zugewiesene Personen)Go (26 Forks)auto 404
documentationenhancementhelp wanted

Repository-Metriken

Stars
 (160 Stars)
PR-Merge-Metriken
 (PR-Metriken ausstehend)

Beschreibung

Create tutorials and or documentation on how to use dranet

The docs are using docsy and placed in https://github.com/google/dranet/tree/main/site/content/docs

The examples manifests are in https://github.com/google/dranet/tree/main/examples

Idially we want to have e2e test that covers the examples, those can be added in https://github.com/google/dranet/tree/main/tests

Contributor Guide

Research-Richtung
Machen Sie sich mit dem docsy Dokumentationssystem und der vorhandenen Dokumentationsstruktur unter https://github.com/google/dranet/tree/main/site/content/docs vertraut. Erstellen Sie dann Tutorials und Dokumentation zur Verwendung von dranet, die die Beispiele unter https://github.com/google/dranet/tree/main/examples abdecken. Stellen Sie außerdem sicher, dass End to End Tests für die Beispiele vorhanden sind, indem Sie sie unter https://github.com/google/dranet/tree/main/tests hinzufügen. Überprüfen Sie die vorhandene Dokumentation auf Stil und Struktur.
Tech Stack
go
Domain
backenddevops
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.
Halber Tag
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
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
75