linera-io/linera-protocol

Ensure all dependencies are documented

Open

#1,540 创建于 2024年1月22日

在 GitHub 查看
 (1 评论) (1 反应) (0 负责人)Rust (32,149 star) (2,354 fork)batch import
documentationgood first issue

描述

We've recently added a few new dependencies on things like Helm, recent Docker versions, and helmfile for certain operations (notably --kubernetes). I've tried to keep the Nix environment up to date, but we should also ensure that these are properly documented on linera.dev.

贡献者指南

技术栈
dockerkubernetes
领域
documentation
议题类型
documentation
难度面向新贡献者的预计实现难度，1 表示很小改动，5 表示专家级工作。
2
预计时间有经验贡献者完成调查、实现、测试并准备 pull request 的粗略时间范围。
1-3 hours
活动状态议题当前的可参与程度：新鲜、活跃、陈旧、阻塞或等待维护者输入。
fresh
清晰度议题是否清楚说明期望改动、验收标准和下一步。
clear
前置要求
familiarity with the project's documentation structurebasic knowledge of Helm and Docker
新手友好度1-100 的估计分数，表示该议题对首次贡献者的友好程度。
85
研究方向
The issue requests updating the linera.dev documentation to include recent dependencies like Helm, specific Docker versions, and helmfile. First, locate the documentation source in the repository (likely under docs/ or a website directory). Then, check the Nix environment file for the exact versions. Finally, add sections explaining the required dependencies and their versions, referencing the existing documentation style. There is no linked PR or additional comments to consider.