testcontainers / testcontainers/testcontainers-python
Updating the documentation
Open
Beginner friendly
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 2.3k
- Forks
- 386
- Avg merge
- 4h 40m
- Merged PRs (30d)
- 1
Description
Hi. After merging support for CrateDB, we can see a cratedb.rst in this repository, but can't find it being rendered on Read the Docs yet. Maybe an update needs to be triggered manually?
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 docs/community/cratedb.rst and compare it with the pages currently rendered at https://testcontainers-python.readthedocs.io/. Check the Read the Docs project or documentation configuration to determine why the page is absent; this is done when the CrateDB documentation is rendered and reachable there.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Active
- Clarity
- Mostly clear
- Newbie friendliness
- 67/100