linera-io/linera-protocol

Ensure all dependencies are documented

Open

#1540 aperta il 22 gen 2024

Vedi su GitHub
 (1 commento) (1 reazione) (0 assegnatari)Rust (2354 fork)batch import
documentationgood first issue

Metriche repository

Star
 (32.149 star)
Metriche merge PR
 (Merge medio 2g 22h) (111 PR mergiate in 30 g)

Descrizione

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.

Guida contributor

Direzione di ricerca
La richiesta chiede di aggiornare la documentazione di linera.dev per includere dipendenze recenti come Helm, versioni specifiche di Docker e helmfile. Innanzitutto, individuare la fonte della documentazione nel repository (probabilmente in docs/ o in una directory del sito web). Quindi, controllare il file di ambiente Nix per le versioni esatte. Infine, aggiungere sezioni che spieghino le dipendenze richieste e le loro versioni, facendo riferimento allo stile di documentazione esistente. Non ci sono PR collegati o commenti aggiuntivi da considerare.
Tech stack
rustdocker
Dominio
documentationdevops
Tipo issue
Documentazione
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
2
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
1-3 ore
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
Attiva
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Chiara
Prerequisiti
Git
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
80