testcontainers / testcontainers/testcontainers-python
Bug: No link to new docs from this repo?
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 2.3k
- Forks
- 386
- Avg merge
- 4h 40m
- Merged PRs (30d)
- 1
Description
Describe the bug
Pull request #822 created a nice-looking docs site. But coming to this repo, I see links to the now almost-empty old docs: https://testcontainers-python.readthedocs.io/en/latest/
Shouldn't we be sending people to the new docs?
I see python.testcontainers.org isn't live yet. I used to be able to see a list of containers: https://testcontainers-python.readthedocs.io/en/testcontainers-v4.2.0/
Now I don't see them: https://testcontainers-python.readthedocs.io/en/testcontainers-v4.12.0/modules/index.html
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
Review pull request #822 and the repository's current documentation links, then compare them with the old Read the Docs pages referenced in the issue. Confirm where the new site should be linked and whether the container list belongs there; done means visitors are directed to the new documentation and the expected container listings are available or the remaining limitation is documented.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 42/100