testcontainers/testcontainers-java

New docs: Convert inline example code to use codeinclude macro

Open

#1 158 ouverte le 19 janv. 2019

Voir sur GitHub
 (2 commentaires) (0 réactions) (0 assignés)Java (1 588 forks)batch import
help wantedresolution/acknowledgedtype/docs

Métriques du dépôt

Stars
 (7 535 stars)
Métriques de merge PR
 (Merge moyen 2j 17h) (2 PRs mergées en 30 j)

Description

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

Guide contributeur

Direction de recherche
Étudiez la documentation mkdocs sur la macro codeinclude, puis choisissez une page non cochée et remplacez les blocs de code en ligne par des références codeinclude vers les fichiers sources appropriés.
Stack technique
java
Domaine
documentation
Type d'issue
Documentation
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
2
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
1-3 heures
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
Active
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
Claire
Prérequis
Gitmkdocs
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
65