linera-io/linera-protocol

Ensure all dependencies are documented

Open

#1540 opened on Jan 22, 2024

View on GitHub
 (1 comment) (1 reaction) (0 assignees)Rust (32,149 stars) (2,354 forks)batch import
documentationgood first issue

Description

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.

Contributor guide

Tech stack
dockerkubernetes
Domain
documentation
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.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
familiarity with the project's documentation structurebasic knowledge of Helm and Docker
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
85
Research direction
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.