Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update Docker requirements page to be more container runtime agnostic #7655

Merged
merged 1 commit into from
Oct 17, 2023

Conversation

kiview
Copy link
Member

@kiview kiview commented Oct 16, 2023

What does this PR do?

Updates the "Docker Requirements" page to become more container runtime agnostic.
It also references Testcontainers Cloud as a supported container runtime, as well as mentioning Testcontainers Desktop as a tool that can make using alternative container runtimes easier.

The table of supported Docker-Environment combinations has been removed.

Aligns the messaging with Testcontainers.com Getting Started Page.

Why is it important?

The previous provided a table that was very detailed with regard to certain Docker versions and environments, however, those were not actively tested. In addition, some of the information and workarounds in this table have become outdated and some mentioned technologies (such as Docker Toolbox) are nowadays obsolete and unmaintained.

Mentioning Testcontainers Cloud and Testcontainers Desktop helps with discovery of these products for OSS users.

This change also embraces the fact, that the container runtime has become much more heterogenous in the recent years, while putting the emphasis on Testcontainers integrating against the Docker-API.

@kiview kiview requested a review from a team as a code owner October 16, 2023 09:44
Comment on lines +5 to +6
To run Testcontainers-based tests,
you need a Docker-API compatible container runtime,
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
To run Testcontainers-based tests,
you need a Docker-API compatible container runtime,
To run Testcontainers-based tests, you need a Docker-API compatible container runtime,

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Oh, the line break here was on purpose, because I use https://sembr.org/ when writing Markdown (generally tends to make diffs easier over time IMO) 😇

Comment on lines +14 to +15
When using those alternatives without Testcontainers Desktop,
sometimes some manual configuration might be necessary
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
When using those alternatives without Testcontainers Desktop,
sometimes some manual configuration might be necessary
When using those alternatives without Testcontainers Desktop, sometimes some manual configuration might be necessary

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@eddumelendez eddumelendez added this to the next milestone Oct 16, 2023
@kiview kiview merged commit 57ca6ad into main Oct 17, 2023
8 checks passed
@kiview kiview deleted the docs-docker-requirements branch October 17, 2023 10:17
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants