linera-io/linera-protocol

Ensure all dependencies are documented

Open

#1 540 ouverte le 22 janv. 2024

Voir sur GitHub
 (1 commentaire) (1 réaction) (0 assignés)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.

Guide contributeur

Stack technique
dockerkubernetes
Domaine
documentation
Type d'issue
documentation
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
2
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
1-3 hours
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
fresh
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
clear
Prérequis
familiarity with the project's documentation structurebasic knowledge of Helm and Docker
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
85
Direction de recherche
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.