Skip to content

Commit 173905c

Browse files
committed
add link to main website
1 parent c341b9f commit 173905c

File tree

2 files changed

+15
-10
lines changed

2 files changed

+15
-10
lines changed

docs/index.md

Lines changed: 13 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -12,25 +12,29 @@
1212
<a href="https://github.com/testcontainers/testcontainers-ruby/" class="card-grid-item" ><img src="language-logos/ruby.svg"/>Ruby</a>
1313
</div>
1414

15-
## About Testcontainers for Python
15+
## About Testcontainers For Python
1616

17-
_Testcontainers for Python_ is a Python library that that makes it simple to create and clean up container-based dependencies for automated integration/smoke tests. The clean, easy-to-use API enables developers to programmatically define containers that should be run as part of a test and clean up those resources when the test is done.
17+
_Testcontainers for Python_ is a Python library that makes it simple to create and clean up container-based dependencies for automated integration or smoke tests. The easy-to-use API enables developers to programmatically define containers that should be run as part of a test and clean up those resources when the test is done.
1818

19-
To start using _Testcontainers for Python_ please read our [quickstart guide](quickstart.md)
19+
To start using _Testcontainers for Python_, see the [quickstart guide](quickstart.md).
20+
21+
!!!note
22+
23+
If you need a high-level explanation of _Testcontainers_, see the [main website](https://testcontainers.com/getting-started/).
2024

2125
## Code Comments
2226

23-
Inline documentation and docs where the code live is crucial for us. Testcontainers Python follows [PEP 257](https://peps.python.org/pep-0257/){:target="\_blank"} comment conventions. The codebase previously supported Sphinx so you may encounter comments not yet updated for the new documentation style.
27+
Inline documentation and docs where the code lives are crucial for us. Testcontainers For Python follows the [PEP 257](https://peps.python.org/pep-0257/){:target="\_blank"} comment conventions. The codebase previously supported Sphinx, so you may encounter comments not yet updated for the new documentation style.
2428

25-
## Who is using Testcontainers Python?
29+
## Who Is Using Testcontainers Python?
2630

27-
- [Timescale](https://www.timescale.com/) - Uses testcontainers-python in their pgai project for testing PostgreSQL integrations, AI model interactions, and AWS service integrations
28-
- [Redis](https://redis.io/) - Depends on testcontainers-python for their redis vector library implementation
29-
- [Apache](https://skywalking.apache.org/) - Uses testcontainers-python in their Skywalking project for application performance monitor tool in distributed systems.
31+
- [Timescale](https://www.timescale.com/) - Uses testcontainers-python in their pgai project for testing PostgreSQL integrations, AI model interactions, and AWS service integrations.
32+
- [Redis](https://redis.io/) - Depends on testcontainers-python for their Redis vector library implementation.
33+
- [Apache](https://skywalking.apache.org/) - Uses testcontainers-python in their Skywalking project for an application performance monitoring tool in distributed systems.
3034

3135
## License
3236

33-
See [LICENSE](https://raw.githubusercontent.com/testcontainers/testcontainers-python/refs/heads/main/LICENSE.txt){:target="\_blank"} .
37+
See [LICENSE](https://raw.githubusercontent.com/testcontainers/testcontainers-python/refs/heads/main/LICENSE.txt){:target="\_blank"}.
3438

3539
## Attributions
3640

docs/quickstart.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,8 @@ In the example above, the default Redis port (6379) is exposed for TCP traffic.
5050
The context manager (`with` statement) ensures containers are cleaned up after tests, so no containers are left running.
5151

5252
!!!tip
53-
See [the garbage collector](features/garbage_collector.md) for another way to clean up resources.
53+
54+
See [the garbage collector](features/garbage_collector.md) for another way to clean up resources.
5455

5556
## 4. Connect your code to the container
5657

0 commit comments

Comments
 (0)