testcontainers/testcontainers-java

New docs: Convert inline example code to use codeinclude macro

Open

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

在 GitHub 查看
 (2 评论) (0 反应) (0 负责人)Java (7,535 star) (1,588 fork)batch import
help wantedresolution/acknowledgedtype/docs

描述

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

贡献者指南

技术栈
java
领域
documentation
议题类型
documentation
难度面向新贡献者的预计实现难度，1 表示很小改动，5 表示专家级工作。
2
预计时间有经验贡献者完成调查、实现、测试并准备 pull request 的粗略时间范围。
1-3 hours
活动状态议题当前的可参与程度：新鲜、活跃、陈旧、阻塞或等待维护者输入。
stale
清晰度议题是否清楚说明期望改动、验收标准和下一步。
clear
前置要求
familiarity with mkdocsunderstanding of codeinclude macro
新手友好度1-100 的估计分数，表示该议题对首次贡献者的友好程度。
80
研究方向
Review the list of documentation pages in the issue description (e.g., docs/features/container logs.md). Check the existing docs for examples of codeinclude usage (some pages like elasticsearch.md and spock.md have been converted). Follow the pattern to replace inline code blocks with codeinclude macros. No maintainer comments were available to review.