google/dranet

Tutorials and Documentation

Open

#73 ouverte le 9 mai 2025

Voir sur GitHub
 (1 commentaire) (0 réactions) (0 assignés)Go (26 forks)auto 404
documentationenhancementhelp wanted

Métriques du dépôt

Stars
 (160 stars)
Métriques de merge PR
 (Métriques PR en attente)

Description

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

Guide contributeur

Direction de recherche
Familiarisez vous avec le système de documentation docsy et la structure de documentation existante sur https://github.com/google/dranet/tree/main/site/content/docs. Créez ensuite des tutoriels et de la documentation sur l'utilisation de dranet, couvrant les exemples sur https://github.com/google/dranet/tree/main/examples. De plus, assurez vous que des tests de bout en bout existent pour les exemples en les ajoutant dans https://github.com/google/dranet/tree/main/tests. Examinez la documentation existante pour le style et la structure.
Stack technique
go
Domaine
backenddevops
Type d'issue
Documentation
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
2
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
Une demi journée
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
Active
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
Claire
Prérequis
GitGo
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
75