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.
Ensure all dependencies are documented · linera-io/linera-protocol#1540 | Good First Issue