testcontainers / testcontainers/testcontainers-java
New docs: Improve database container usage examples
Open
Nobody has claimed this yet.
help wanted
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.
Aim to bring all of the database module documentation up to a similar standard, including:
- All examples should be 'codeincluded' in
- Container object/rule examples
- JDBC URL examples where appropriate
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
Start by locating the new MkDocs documentation and the database module pages. Inventory the existing examples, then bring them up to the stated standard: codeinclude examples, container object/rule examples, and JDBC URL examples where appropriate.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- docker, java
- Domain
- databases, documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100