testcontainers / testcontainers/testcontainers-scala
Consider removing old API syntax from documentation
Nobody has claimed this yet.
- Dominant language
- Scala
- Stars
- 668
- Forks
- 136
- PR merge metrics
- No merged PRs in 30d
Description
I am a newcomer to this project, I find it very useful, thanks for working on it.
When reading the documentation, I was puzzled at first to first read code snippets based on the ForEachTestContainer and ForAllTestContainer syntax, then to discover a new API based on TestContainerForAll and TestContainerForEach was now the recommended approach.
I understand the new API syntax has been around for about 3 years now, so I suggest to re-write all code snippets with it as well as Container.Def (most of which is already present in the "new API" section of the doc), and to either remove the mentions of the old syntax or to move it down to some "legacy" section or so.
This seems easy enough to do, so if you agree I'm happy to submit a minor PR with such change.
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
Search the documentation for examples using ForEachTestContainer, ForAllTestContainer, and Container.Def, then compare them with the newer TestContainerForAll and TestContainerForEach examples. Update the snippets to consistently show the recommended API and either remove old-syntax references or place them in a legacy section; done when the documentation no longer presents the old syntax as current.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- docker, scala
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 38/100