testcontainers / testcontainers/testcontainers-java
New docs: minimal docs for modules that lack them
Offen
Dieses Issue hat noch niemand übernommen.
help wanted
resolution/acknowledged
type/docs
- Vorherrschende Sprache
- Java
- Sterne
- 8.7k
- Forks
- 1.9k
- Ø Merge
- 2 T. 17 Std.
- Gemergte PRs (30 T.)
- 9
Beschreibung
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
Beitragsleitfaden
Erste Schritte
- Lies das ganze Issue und danach den Beitragsleitfaden des Projekts.
- Schreib ins Issue, dass du es übernimmst — das erspart doppelte Arbeit.
- Forke das Repository und arbeite in einem Branch.
- Öffne einen Pull Request, der die Issue-Nummer nennt.
Rechercherichtung
Überprüfe die neue auf mkdocs basierende Dokumentationsstruktur und die Modulseiten für docs/modules/mockserver.md, docs/modules/nginx.md und docs/modules/pulsar.md. Verwende das codeinclude-Makro für grundlegende Dokumentation und Beispiele für jedes Modul; abgeschlossen ist die Aufgabe, wenn alle drei Seiten minimale nutzbare Dokumentation und Beispiele enthalten.
Vom Indexierungsmodell aus dem Issue-Text verfasst.
Bewertung
- Tech-Stack
- java, nginx
- Bereich
- documentation
- Issue-Typ
- Dokumentation
- Schwierigkeit
- 3/5
- Geschätzter Aufwand
- 1-2 Tage
- Aktivitätsstatus
- Veraltet
- Klarheit
- Größtenteils klar
- Anfängerfreundlichkeit
- 35/100