From c0d73a6d92de6b827b68ba9ef0a0111aa2bddb74 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Manuel=20de=20la=20Pe=C3=B1a?= Date: Thu, 13 Oct 2022 15:23:11 +0200 Subject: [PATCH] docs: add general Docker requirements (#565) * chore: move system requirements to its own folder * docs: add a general Docker requirements overview page --- docs/system_requirements/index.md | 12 ++++++++++++ .../using_colima.md | 0 .../using_podman.md | 0 mkdocs.yml | 5 +++-- 4 files changed, 15 insertions(+), 2 deletions(-) create mode 100644 docs/system_requirements/index.md rename docs/{features => system_requirements}/using_colima.md (100%) rename docs/{features => system_requirements}/using_podman.md (100%) diff --git a/docs/system_requirements/index.md b/docs/system_requirements/index.md new file mode 100644 index 0000000000..6df288ec3c --- /dev/null +++ b/docs/system_requirements/index.md @@ -0,0 +1,12 @@ +# General Docker requirements + +## Overview + +Testcontainers requires a Docker-API compatible container runtime. +During development, Testcontainers is actively tested against recent versions of Docker on Linux, as well as against Docker Desktop on Mac and Windows. +These Docker environments are automatically detected and used by Testcontainers without any additional configuration being necessary. + +It is possible to configure Testcontainers to work for other Docker setups, such as a remote Docker host or Docker alternatives. +However, these are not actively tested in the main development workflow, so not all Testcontainers features might be available and additional manual configuration might be necessary. +If you have further questions about configuration details for your setup or whether it supports running Testcontainers-based tests, +please contact the Testcontainers team and other users from the Testcontainers community on [Slack](https://slack.testcontainers.org/). diff --git a/docs/features/using_colima.md b/docs/system_requirements/using_colima.md similarity index 100% rename from docs/features/using_colima.md rename to docs/system_requirements/using_colima.md diff --git a/docs/features/using_podman.md b/docs/system_requirements/using_podman.md similarity index 100% rename from docs/features/using_podman.md rename to docs/system_requirements/using_podman.md diff --git a/mkdocs.yml b/mkdocs.yml index 71d7db108e..a9a9ef7f11 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -51,8 +51,9 @@ nav: - examples/nginx.md - examples/redis.md - System Requirements: - - features/using_colima.md - - features/using_podman.md + - system_requirements/index.md + - system_requirements/using_colima.md + - system_requirements/using_podman.md - Contributing: - contributing.md - contributing_docs.md