testcontainers / testcontainers/testcontainers-java
New docs: minimal docs for modules that lack them
Nessuno ha ancora preso questa issue.
- Lingua principale
- Java
- Stelle
- 8.7k
- Fork
- 1.9k
- Merge medio
- 2g 17h
- PR unite (30g)
- 9
Descrizione
Improvement for the new mkdocs-based documentation.
I'd expect that this doesn't need to be done in one big PR; it could be several.
We need some basic docs and examples (pulled in using the codeinclude macro) for:
- docs/modules/mockserver.md
- docs/modules/nginx.md
- docs/modules/pulsar.md
Guida per i contributori
Apri la guida per i contributori
Come iniziare
- Leggi tutta la issue e poi la guida ai contributi del progetto.
- Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
- Fai un fork del repository e lavora su un branch.
- Apri una pull request che faccia riferimento al numero della issue.
Direzione di ricerca
Esamina la nuova struttura della documentazione basata su mkdocs e le pagine dei moduli per docs/modules/mockserver.md, docs/modules/nginx.md e docs/modules/pulsar.md. Usa la macro codeinclude per la documentazione di base e gli esempi di ciascun modulo; il lavoro è completato quando tutte e tre le pagine contengono documentazione ed esempi minimi utilizzabili.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Valutazione
- Stack tecnologico
- java, nginx
- Ambito
- documentation
- Tipo di issue
- Documentazione
- Difficoltà
- 3/5
- Tempo stimato
- 1-2 giorni
- Stato di attività
- Ferma
- Chiarezza
- Abbastanza chiara
- Idoneità per principianti
- 35/100