testcontainers / testcontainers/testcontainers-java
New docs: Convert inline example code to use codeinclude macro
Dieses Issue hat noch niemand übernommen.
- 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.
Aim to replace the majority of inline code blocks in the docs with codeinclude macros, so that our examples are compiled and tested as part of the build.
This doesn't need to all be done in one PR - it probably ought to be split.
Pages that would benefit from this (in no particular order):
- docs/features/container_logs.md
- docs/features/commands.md
- docs/features/creating_container.md
- docs/features/creating_images.md
- docs/features/files.md
- docs/modules/docker_compose.md
- docs/modules/elasticsearch.md
- docs/modules/kafka.md
- docs/modules/vault.md
- docs/modules/webdriver_containers.md
- docs/test_framework_integration/junit_4.md
- docs/test_framework_integration/junit_5.md
- docs/test_framework_integration/spock.md
- docs/supported_docker_environment/logging_config.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
Beginne mit einer noch nicht überprüften Seite, etwa docs/features/container_logs.md, und vergleiche sie mit den abgeschlossenen Konvertierungen in docs/modules/elasticsearch.md oder docs/test_framework_integration/spock.md. Ersetze geeignete Inline-Beispiele durch das codeinclude-Makro und führe anschließend den Dokumentations-Build aus, um zu bestätigen, dass die Beispiele kompiliert und getestet werden.
Vom Indexierungsmodell aus dem Issue-Text verfasst.
Bewertung
- Tech-Stack
- docker, java
- Bereich
- documentation
- Issue-Typ
- Dokumentation
- Schwierigkeit
- 3/5
- Geschätzter Aufwand
- 1-2 Tage
- Aktivitätsstatus
- Veraltet
- Klarheit
- Größtenteils klar
- Anfängerfreundlichkeit
- 42/100