testcontainers/testcontainers-java

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

Open

#1,164 建立於 2019年1月20日

在 GitHub 查看
 (1 留言) (0 反應) (0 負責人)Java (7,535 star) (1,588 fork)batch import
help wantedresolution/acknowledgedtype/docs

描述

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

貢獻者指南

技術棧
javadocker
領域
documentation
議題類型
documentation
難度面向新貢獻者的預計實作難度，1 表示很小改動，5 表示專家級工作。
2
預計時間有經驗貢獻者完成調查、實作、測試並準備 pull request 的粗略時間範圍。
1-3 hours
活動狀態議題目前的可參與程度：新鮮、活躍、陳舊、阻塞或等待維護者輸入。
stale
清晰度議題是否清楚說明預期改動、驗收標準和下一步。
clear
前置要求
Basic knowledge of TestcontainersFamiliarity with Docker container file systems
新手友善度1-100 的估計分數，表示該議題對首次貢獻者的友善程度。
70
研究方向
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.