testcontainers/testcontainers-java

New docs: document use of APIs for copying files to/from containers

Open

#1,164 opened on Jan 20, 2019

View on GitHub
 (1 comment) (0 reactions) (0 assignees)Java (1,588 forks)batch import
help wantedresolution/acknowledgedtype/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.

  • Add to docs, with examples brought in via codeinclude.
  • Explain preference for using the copy APIs instead of volume mounts

Contributor guide

Research direction
Review the existing mkdocs documentation structure and the copy APIs implementation in the codebase to create accurate documentation with code examples explaining the preference over volume mounts.
Tech stack
java
Domain
backend
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
Git
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
75