testcontainers / testcontainers/testcontainers-java
New docs: minimal docs for modules that lack them
Open
Nobody has claimed this yet.
help wanted
resolution/acknowledged
type/docs
- Dominant language
- Java
- Stars
- 8.7k
- Forks
- 1.9k
- Avg merge
- 2d 17h
- Merged PRs (30d)
- 9
Description
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
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Review the new mkdocs-based documentation structure and the module pages for docs/modules/mockserver.md, docs/modules/nginx.md, and docs/modules/pulsar.md. Use the codeinclude macro for basic documentation and examples for each module; done means all three pages contain minimal usable docs and examples.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- java, nginx
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100