testcontainers/testcontainers-java

New docs: minimal docs for modules that lack them

Open

#1,160 opened on 2019年1月19日

GitHub で見る
 (2 comments) (0 reactions) (0 assignees)Java (7,535 stars) (1,588 forks)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
Issue 種別
documentation
難度新しい貢献者にとっての実装難度です。1 は非常に小さな変更、5 は専門的な作業です。
2
推定時間経験ある貢献者が調査、実装、テスト、pull request 準備にかけるおおよその時間範囲です。
1-2 days
活動状況Issue が今どれだけ取り組みやすいかを示します。新しい、活発、古い、ブロック中、またはメンテナー入力待ちなどです。
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`.