testcontainers/testcontainers-java

New docs: Improve database container usage examples

Open

#1,156 opened on Jan 19, 2019

View on GitHub
 (4 comments) (0 reactions) (0 assignees)Java (1,588 forks)batch import
help wantedtype/docs

Repository metrics

Stars
 (7,535 stars)
PR merge metrics
 (Avg merge 2d 17h) (2 merged PRs in 30d)

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

Research direction
Review the existing documentation for database modules and identify which examples need to be updated to use codeincludes, container object/rule patterns, and JDBC URL examples.
Tech stack
java
Domain
backendtesting
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
JavaDocker
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
80