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 (7,535 stars) (1,588 forks)batch import
help wantedresolution/acknowledgedtype/docs

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

Tech stack
javadocker
Domain
documentation
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.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
Basic knowledge of TestcontainersFamiliarity with Docker container file systems
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70
Research direction
The issue asks to add documentation for using APIs to copy files to/from containers in the new mkdocs based docs. Look at the existing docs structure in the repository, likely under the docs/ directory. Use codeinclude to bring in examples from the codebase. The documentation should explain the preference for using the copy APIs instead of volume mounts. There is one comment on the issue that may provide additional context. Check the link to the issue and any related discussions. No linked PRs or assignees.