testcontainers/testcontainers-java

New docs: minimal docs for modules that lack them

Open

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

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

仓库指标

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

描述

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

贡献者指南

研究方向
阅读类似模块（例如 docs/modules/postgresql.md）的现有文档，并使用 codeinclude 宏从相应的测试类中包含代码示例。
技术栈
java
领域
documentation
议题类型
文档
难度面向新贡献者的预计实现难度，1 表示很小改动，5 表示专家级工作。
2
预计时间有经验贡献者完成调查、实现、测试并准备 pull request 的粗略时间范围。
1-3 小时
活动状态议题当前的可参与程度：新鲜、活跃、陈旧、阻塞或等待维护者输入。
活跃
清晰度议题是否清楚说明期望改动、验收标准和下一步。
清晰
前置要求
Git
新手友好度1-100 的估计分数，表示该议题对首次贡献者的友好程度。
80