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.