google/dranet

Tutorials and Documentation

Open

#73 aperta il 9 mag 2025

Vedi su GitHub
 (1 commento) (0 reazioni) (0 assegnatari)Go (26 fork)auto 404
documentationenhancementhelp wanted

Metriche repository

Star
 (160 star)
Metriche merge PR
 (Metriche PR in attesa)

Descrizione

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

Guida contributor

Direzione di ricerca
Familiarizzati con il sistema di documentazione docsy e la struttura esistente della documentazione su https://github.com/google/dranet/tree/main/site/content/docs. Quindi crea tutorial e documentazione su come utilizzare dranet, coprendo gli esempi su https://github.com/google/dranet/tree/main/examples. Inoltre, assicurati che esistano test end to end per gli esempi aggiungendoli in https://github.com/google/dranet/tree/main/tests. Rivedi la documentazione esistente per stile e struttura.
Tech stack
go
Dominio
backenddevops
Tipo issue
Documentazione
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
2
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
Mezza giornata
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
Attiva
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Chiara
Prerequisiti
GitGo
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
75