linera-io/linera-protocol

Ensure all dependencies are documented

Open

#1.540 geöffnet am 22. Jan. 2024

Auf GitHub ansehen
 (1 Kommentar) (1 Reaktion) (0 zugewiesene Personen)Rust (32.149 Stars) (2.354 Forks)batch import
documentationgood first issue

Beschreibung

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
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
2
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
1-3 hours
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
fresh
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
clear
Voraussetzungen
familiarity with the project's documentation structurebasic knowledge of Helm and Docker
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
85
Research-Richtung
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.