From f4ff76fd828b54e0d1a13a18f774023489e1e9ce Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Manuel=20de=20la=20Pe=C3=B1a?= Date: Fri, 26 May 2023 09:36:52 +0200 Subject: [PATCH 1/2] docs: document the Go version --- docs/system_requirements/index.md | 12 ++++++++++-- 1 file changed, 10 insertions(+), 2 deletions(-) diff --git a/docs/system_requirements/index.md b/docs/system_requirements/index.md index 6df288ec3c..16e5a3d9de 100644 --- a/docs/system_requirements/index.md +++ b/docs/system_requirements/index.md @@ -1,6 +1,14 @@ -# General Docker requirements +# System Requirements -## Overview +## Go version + +From the [Go Release Policy](https://go.dev/doc/devel/release#policy): + +> Each major Go release is supported until there are two newer major releases. For example, Go 1.5 was supported until the Go 1.7 release, and Go 1.6 was supported until the Go 1.8 release. We fix critical problems, including critical security problems, in supported releases as needed by issuing minor revisions (for example, Go 1.6.1, Go 1.6.2, and so on). + +_Testcontainers for Go_ is tested against those two latest Go releases, therefore we recommend using any of them. You could check what versions are actually supported by looking at the [GitHub Action](../../.github/workflows/ci.yml) configuration, under the `test.strategy.matrix.go-version` key. + +## General Docker requirements 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. From c955a8faff5c0b0d462d38d73f5816a7f2629f69 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Manuel=20de=20la=20Pe=C3=B1a?= Date: Fri, 26 May 2023 09:53:32 +0200 Subject: [PATCH 2/2] docs: separate concerns --- docs/system_requirements/docker.md | 10 ++++++++++ docs/system_requirements/index.md | 15 +-------------- mkdocs.yml | 1 + 3 files changed, 12 insertions(+), 14 deletions(-) create mode 100644 docs/system_requirements/docker.md diff --git a/docs/system_requirements/docker.md b/docs/system_requirements/docker.md new file mode 100644 index 0000000000..c7d014cdec --- /dev/null +++ b/docs/system_requirements/docker.md @@ -0,0 +1,10 @@ +# General Docker requirements + +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/system_requirements/index.md b/docs/system_requirements/index.md index 16e5a3d9de..c79452a4c2 100644 --- a/docs/system_requirements/index.md +++ b/docs/system_requirements/index.md @@ -1,20 +1,7 @@ -# System Requirements - -## Go version +# Go version From the [Go Release Policy](https://go.dev/doc/devel/release#policy): > Each major Go release is supported until there are two newer major releases. For example, Go 1.5 was supported until the Go 1.7 release, and Go 1.6 was supported until the Go 1.8 release. We fix critical problems, including critical security problems, in supported releases as needed by issuing minor revisions (for example, Go 1.6.1, Go 1.6.2, and so on). _Testcontainers for Go_ is tested against those two latest Go releases, therefore we recommend using any of them. You could check what versions are actually supported by looking at the [GitHub Action](../../.github/workflows/ci.yml) configuration, under the `test.strategy.matrix.go-version` key. - -## General Docker requirements - -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/mkdocs.yml b/mkdocs.yml index 2b249fdde7..c3766cf77f 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -82,6 +82,7 @@ nav: - examples/toxiproxy.md - System Requirements: - system_requirements/index.md + - system_requirements/docker.md - system_requirements/using_colima.md - system_requirements/using_podman.md - Contributing: