google/dranet

Tutorials and Documentation

Open

#73 opened on May 9, 2025

View on GitHub
 (1 comment) (0 reactions) (0 assignees)Go (26 forks)auto 404
documentationenhancementhelp wanted

Repository metrics

Stars
 (160 stars)
PR merge metrics
 (PR metrics pending)

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

Contributor guide

Research direction
Familiarize yourself with the docsy documentation system and the existing docs structure at https://github.com/google/dranet/tree/main/site/content/docs. Then create tutorials and documentation for using dranet, covering the examples at https://github.com/google/dranet/tree/main/examples. Additionally, ensure e2e tests exist for the examples by adding them in https://github.com/google/dranet/tree/main/tests. Review the existing documentation for style and structure.
Tech stack
go
Domain
backenddevops
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
GitGo
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
75