testcontainers / testcontainers/testcontainers-java
New docs: Startup strategy information/examples
Open
Nobody has claimed this yet.
help wanted
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 a section 'Startup Strategies' to docs/features/startup_and_waits.md describing the default and 'one-shot' strategies, with a codeincluded example for the latter.
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
Open docs/features/startup_and_waits.md and review its existing structure and examples first. Add a Startup Strategies section covering the default and one-shot strategies, including a codeincluded example for the one-shot strategy; the documentation is done when both strategies and the example are clearly described.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- markdown
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 45/100