testcontainers/testcontainers-java

New docs: minimal docs for modules that lack them

Open

#1,160 建立於 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.

I'd expect that this doesn't need to be done in one big PR; it could be several.

We need some basic docs and examples (pulled in using the codeinclude macro) for:

  • docs/modules/mockserver.md
  • docs/modules/nginx.md
  • docs/modules/pulsar.md

貢獻者指南

技術棧
javadocker
領域
documentation
議題類型
documentation
難度面向新貢獻者的預計實作難度，1 表示很小改動，5 表示專家級工作。
2
預計時間有經驗貢獻者完成調查、實作、測試並準備 pull request 的粗略時間範圍。
1-2 days
活動狀態議題目前的可參與程度：新鮮、活躍、陳舊、阻塞或等待維護者輸入。
stale
清晰度議題是否清楚說明預期改動、驗收標準和下一步。
clear
前置要求
JavaDockerTestcontainersDocumentation
新手友善度1-100 的估計分數，表示該議題對首次貢獻者的友善程度。
80
研究方向
Start by examining existing module documentation files in the `docs/modules/` directory to understand the pattern. Use the `codeinclude` macro to embed relevant code examples from the corresponding module source. Contributing guidelines may provide further details on the documentation style. The three modules needing documentation are `mockserver`, `nginx`, and `pulsar`.