testcontainers/testcontainers-java

New docs: Convert inline example code to use codeinclude macro

开放

#1,158 创建于 2019年1月19日

 (2 条评论) (0 个反应) (0 位负责人)Java (1,588 个派生)batch import
help wantedresolution/acknowledgedtype/docs

仓库指标

星标
 (7,535 个星标)
PR 合并指标
 (平均合并 2天 17小时) (30 天内合并 2 个 PR)

描述

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

贡献者指南