google/dranet

Tutorials and Documentation

Open

#73 创建于 2025年5月9日

在 GitHub 查看
 (1 评论) (0 反应) (0 负责人)Go (26 fork)auto 404
documentationenhancementhelp wanted

仓库指标

Star
 (160 star)
PR 合并指标
 (PR 指标待抓取)

描述

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

贡献者指南

研究方向
熟悉 docsy 文档系统和现有文档结构（位于 https://github.com/google/dranet/tree/main/site/content/docs）。然后创建关于如何使用 dranet 的教程和文档，覆盖位于 https://github.com/google/dranet/tree/main/examples 的示例。此外，确保示例有端到端测试，可在 https://github.com/google/dranet/tree/main/tests 中添加。查看现有文档的风格和结构。
技术栈
go
领域
backenddevops
议题类型
文档
难度面向新贡献者的预计实现难度，1 表示很小改动，5 表示专家级工作。
2
预计时间有经验贡献者完成调查、实现、测试并准备 pull request 的粗略时间范围。
半天
活动状态议题当前的可参与程度：新鲜、活跃、陈旧、阻塞或等待维护者输入。
活跃
清晰度议题是否清楚说明期望改动、验收标准和下一步。
清晰
前置要求
GitGo
新手友好度1-100 的估计分数，表示该议题对首次贡献者的友好程度。
75