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 (2 354 forks)batch import
documentationgood first issue

Métriques du dépôt

Stars
 (32 149 stars)
Métriques de merge PR
 (Merge moyen 2j 22h) (111 PRs mergées en 30 j)

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

Direction de recherche
La demande consiste à mettre à jour la documentation de linera.dev pour inclure des dépendances récentes comme Helm, des versions spécifiques de Docker et helmfile. Tout d'abord, localisez la source de la documentation dans le dépôt (probablement sous docs/ ou un répertoire de site web). Ensuite, vérifiez le fichier d'environnement Nix pour obtenir les versions exactes. Enfin, ajoutez des sections expliquant les dépendances requises et leurs versions, en vous référant au style de documentation existant. Il n'y a pas de PR lié ni de commentaires supplémentaires à prendre en compte.
Stack technique
rustdocker
Domaine
documentationdevops
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 heures
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
Active
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
Claire
Prérequis
Git
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
80