Hacktoberfest 2026: le issue che i maintainer hanno segnato per ottobre, aperte e adatte ai principianti. Sfoglia le issue Hacktoberfest

explore automating docs generation using `terraform-docs`

Aperta
#32 1 commento 0 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
5/5
Tempo stimato
Più di una settimana
Idoneità per principianti
25/100
Tipo di issue
Funzionalità
Chiarezza
Da chiarire
Stato di attività
Ferma
Stack tecnologico
terraform
Ambito
documentation

Direzione di ricerca

Inizia esaminando la documentazione attuale dei moduli Terraform del repository e le indicazioni di terraform-docs per includere esempi. Determina l’ambito di una generazione coerente tra i moduli e documenta un approccio di automazione concordato. Il lavoro sarà considerato completato quando il progetto avrà un piano chiaro e manutenibile per generare questa documentazione in modo coerente.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

terraform-docs is a plugin for auto-generating terraform module docs and supports, including examples, as we currently do with our docs.

This will let us ensure that the docs are consistent across modules as the registry size grows.

Lingua principale
HCL
Stelle
80
Fork
161
Merge medio
1g 14h
PR unite (30g)
38

Guida per i contributori

Apri la guida per i contributori

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di coder/registry

Tutte le issue di coder/registry

Issue simili

Altre issue su Documentation

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.