testcontainers / testcontainers/testcontainers-java
New docs: document use of APIs for copying files to/from containers
Open
Beginner friendly
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.
- Add to docs, with examples brought in via codeinclude.
- Explain preference for using the copy APIs instead of volume mounts
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 with the new mkdocs-based documentation and locate the section covering container file transfers. Add examples brought in via codeinclude, document the copy APIs for copying files to and from containers, and explain why they are preferred over volume mounts; done when both checklist items are covered.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- docker, java
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Quiet
- Clarity
- Mostly clear
- Newbie friendliness
- 64/100