Conversation
mtremsal
left a comment
There was a problem hiding this comment.
Some suggestions to clean-up the language a bit.
docs/_redirects
Outdated
| /usage/neo4j_container.html /modules/databases/neo4j/ | ||
| /compatibility.html /supported_docker_environment/ | ||
| /on_failure.html /supported_docker_environment/ | ||
| /on_failure.html /on_failure |
There was a problem hiding this comment.
Let's have a more descriptive url. e.g. error_missing_container_runtime_environment.html
docs/on_failure.md
Outdated
|
|
||
| If you ended up on this page, | ||
| it seems that either Testcontainers was not able to find a supported container runtime in your environment, | ||
| or you found page while browsing the documentation in search of information on dealing with errors regarding Testcontainers' environment discovery mechanism. |
There was a problem hiding this comment.
or you found this page while searching for information to deal with errors regarding the environment discovery mechanism of Testcontainers.
docs/on_failure.md
Outdated
| it seems that either Testcontainers was not able to find a supported container runtime in your environment, | ||
| or you found page while browsing the documentation in search of information on dealing with errors regarding Testcontainers' environment discovery mechanism. | ||
|
|
||
| Testcontainers requires a supported container runtime environment to be present in order to function. |
There was a problem hiding this comment.
Testcontainers requires a supported container runtime environment to be present in order to execute containers.
docs/on_failure.md
Outdated
| or you found page while browsing the documentation in search of information on dealing with errors regarding Testcontainers' environment discovery mechanism. | ||
|
|
||
| Testcontainers requires a supported container runtime environment to be present in order to function. | ||
| Here is a list of supported container runtime environments, that can get you up to speed quickly: |
There was a problem hiding this comment.
Here is a list of supported container runtime environments:
docs/on_failure.md
Outdated
| * [Docker Engine on Linux](https://docs.docker.com/engine/install/) | ||
| * [Testcontainers Cloud](https://www.testcontainers.cloud) | ||
|
|
||
| For more extensive information on supported container runtime environments, and how to configure container runtime environments that are not supported by default, |
There was a problem hiding this comment.
For more extensive information on supported container runtime environments, as well as known limitations of alternative container runtime environments, please refer to...
Marc's recommendations from the review
When Testcontainers fails to automatically discover a supported container runtime environments, it will log a human readable error message with a link, pointing to https://www.testcontainers.org/supported_docker_environment/. In order to give new users with less Docker experience more suitable hints on how to fix their issue, we intend to explore ways to make the documentation more streamlined.