testcontainers / testcontainers/testcontainers-java
New docs: Convert inline example code to use codeinclude macro
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.
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
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
Inizia con una pagina non ancora verificata, ad esempio docs/features/container_logs.md, e confrontala con le conversioni completate in docs/modules/elasticsearch.md o docs/test_framework_integration/spock.md. Sostituisci gli esempi inline appropriati con la macro codeinclude, quindi esegui la build della documentazione per confermare che gli esempi vengano compilati e testati.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Valutazione
- Stack tecnologico
- docker, java
- Ambito
- documentation
- Tipo di issue
- Documentazione
- Difficoltà
- 3/5
- Tempo stimato
- 1-2 giorni
- Stato di attività
- Ferma
- Chiarezza
- Abbastanza chiara
- Idoneità per principianti
- 42/100