linera-io/linera-protocol

Ensure all dependencies are documented

Open

#1.540 aberto em 22 de jan. de 2024

Ver no 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.

Guia do colaborador

Pilha de tecnologia
dockerkubernetes
Domain
documentation
Tipo Issue
documentation
DifficultyDificuldade de implementação estimada para um novo contribuidor, de 1 para alterações muito pequenas a 5 para trabalho de nível especializado.
2
Tempo estimadoUm intervalo de tempo aproximado para um colaborador experiente investigar, implementar, testar e preparar um pull request.
1-3 hours
Status da atividadeQuão disponível o issue aparece agora: novo, ativo, obsoleto, bloqueado ou aguardando entrada do mantenedor.
fresh
ClarityCom que clareza o issue explica a mudança esperada, os critérios de aceitação e a próxima etapa.
clear
Prerequisites
familiarity with the project's documentation structurebasic knowledge of Helm and Docker
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
85
Direção de pesquisa
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.