docs: indicate version for the Run function (#2627)

* docs: indicate version for the Run function

* docs(cockroachdb): move info message to the right section

* docs: proper info architecture

Author: mdelapenya

docs/modules/artemis.md

@@ -24,7 +24,14 @@ go get github.com/testcontainers/testcontainers-go/modules/artemis
 [Connecting to an Artemis container](../../modules/artemis/examples_test.go) inside_block:connectToArtemisContainer
 <!--/codeinclude-->
 
-## Module reference
+## Module Reference
+
+### Run function
+
+- Not available until the next release of testcontainers-go <a href="https://github.com/testcontainers/testcontainers-go"><span class="tc-version">:material-tag: main</span></a>
+
+!!!info
+    The `RunContainer(ctx, opts...)` function is deprecated and will be removed in the next major release of _Testcontainers for Go_.
 
 The Artemis module exposes one entrypoint function to create the Artemis container, and this function receives three parameters:
 

docs/modules/azurite.md

@@ -20,7 +20,14 @@ go get github.com/testcontainers/testcontainers-go/modules/azurite
 [Creating a Azurite container](../../modules/azurite/examples_test.go) inside_block:runAzuriteContainer
 <!--/codeinclude-->
 
-## Module reference
+## Module Reference
+
+### Run function
+
+- Not available until the next release of testcontainers-go <a href="https://github.com/testcontainers/testcontainers-go"><span class="tc-version">:material-tag: main</span></a>
+
+!!!info
+    The `RunContainer(ctx, opts...)` function is deprecated and will be removed in the next major release of _Testcontainers for Go_.
 
 The Azurite module exposes one entrypoint function to create the Azurite container, and this function receives three parameters:
 

docs/modules/cassandra.md

@@ -20,7 +20,14 @@ go get github.com/testcontainers/testcontainers-go/modules/cassandra
 [Creating a Cassandra container](../../modules/cassandra/examples_test.go) inside_block:runCassandraContainer
 <!--/codeinclude-->
 
-## Module reference
+## Module Reference
+
+### Run function
+
+- Not available until the next release of testcontainers-go <a href="https://github.com/testcontainers/testcontainers-go"><span class="tc-version">:material-tag: main</span></a>
+
+!!!info
+    The `RunContainer(ctx, opts...)` function is deprecated and will be removed in the next major release of _Testcontainers for Go_.
 
 The Cassandra module exposes one entrypoint function to create the Cassandra container, and this function receives three parameters:
 

docs/modules/chroma.md

@@ -25,7 +25,14 @@ go get github.com/testcontainers/testcontainers-go/modules/chroma
 [Creating a Chroma container](../../modules/chroma/examples_test.go) inside_block:runChromaContainer
 <!--/codeinclude-->
 
-## Module reference
+## Module Reference
+
+### Run function
+
+- Not available until the next release of testcontainers-go <a href="https://github.com/testcontainers/testcontainers-go"><span class="tc-version">:material-tag: main</span></a>
+
+!!!info
+    The `RunContainer(ctx, opts...)` function is deprecated and will be removed in the next major release of _Testcontainers for Go_.
 
 The Chroma module exposes one entrypoint function to create the Chroma container, and this function receives three parameters:
 

docs/modules/clickhouse.md

@@ -20,7 +20,14 @@ go get github.com/testcontainers/testcontainers-go/modules/clickhouse
 [Test for a ClickHouse container](../../modules/clickhouse/examples_test.go) inside_block:runClickHouseContainer
 <!--/codeinclude-->
 
-## Module reference
+## Module Reference
+
+### Run function
+
+- Not available until the next release of testcontainers-go <a href="https://github.com/testcontainers/testcontainers-go"><span class="tc-version">:material-tag: main</span></a>
+
+!!!info
+    The `RunContainer(ctx, opts...)` function is deprecated and will be removed in the next major release of _Testcontainers for Go_.
 
 The ClickHouse module exposes one entrypoint function to create the ClickHouse container, and this function receives three parameters:
 

docs/modules/cockroachdb.md

@@ -20,7 +20,14 @@ go get github.com/testcontainers/testcontainers-go/modules/cockroachdb
 [Creating a CockroachDB container](../../modules/cockroachdb/examples_test.go) inside_block:runCockroachDBContainer
 <!--/codeinclude-->
 
-## Module reference
+## Module Reference
+
+### Run function
+
+- Not available until the next release of testcontainers-go <a href="https://github.com/testcontainers/testcontainers-go"><span class="tc-version">:material-tag: main</span></a>
+
+!!!info
+    The `RunContainer(ctx, opts...)` function is deprecated and will be removed in the next major release of _Testcontainers for Go_.
 
 The CockroachDB module exposes one entrypoint function to create the CockroachDB container, and this function receives three parameters:
 
@@ -32,9 +39,6 @@ func Run(ctx context.Context, img string, opts ...testcontainers.ContainerCustom
 - `string`, the Docker image to use.
 - `testcontainers.ContainerCustomizer`, a variadic argument for passing options.
 
-!!!warning
-    When TLS is enabled there's a very small, unlikely chance that the underlying driver can panic when registering the driver as part of waiting for CockroachDB to be ready to accept connections. If this is repeatedly happening please open an issue.
-
 ### Container Options
 
 When starting the CockroachDB container, you can pass options in a variadic way to configure it.
@@ -65,6 +69,9 @@ Internally CockroachDB requires a client certificate for the user to connect wit
 
 A helper `cockroachdb.NewTLSConfig` exists to generate all of this for you.
 
+!!!warning
+    When TLS is enabled there's a very small, unlikely chance that the underlying driver can panic when registering the driver as part of waiting for CockroachDB to be ready to accept connections. If this is repeatedly happening please open an issue.
+
 ### Container Methods
 
 The CockroachDB container exposes the following methods:

docs/modules/consul.md

@@ -20,7 +20,14 @@ go get github.com/testcontainers/testcontainers-go/modules/consul
 [Creating a Consul container](../../modules/consul/examples_test.go) inside_block:runConsulContainer
 <!--/codeinclude-->
 
-## Module reference
+## Module Reference
+
+### Run function
+
+- Not available until the next release of testcontainers-go <a href="https://github.com/testcontainers/testcontainers-go"><span class="tc-version">:material-tag: main</span></a>
+
+!!!info
+    The `RunContainer(ctx, opts...)` function is deprecated and will be removed in the next major release of _Testcontainers for Go_.
 
 The Consul module exposes one entrypoint function to create the Consul container, and this function receives three parameters:
 

docs/modules/couchbase.md

@@ -22,6 +22,13 @@ go get github.com/testcontainers/testcontainers-go/modules/couchbase
 
 ## Module Reference
 
+### Run function
+
+- Not available until the next release of testcontainers-go <a href="https://github.com/testcontainers/testcontainers-go"><span class="tc-version">:material-tag: main</span></a>
+
+!!!info
+    The `RunContainer(ctx, opts...)` function is deprecated and will be removed in the next major release of _Testcontainers for Go_.
+
 The Couchbase module exposes one entrypoint function to create the Couchbase container, and this function receives three parameters:
 
 ```golang

docs/modules/dolt.md

@@ -20,7 +20,14 @@ go get github.com/testcontainers/testcontainers-go/modules/dolt
 [Creating a Dolt container](../../modules/dolt/examples_test.go) inside_block:runDoltContainer
 <!--/codeinclude-->
 
-## Module reference
+## Module Reference
+
+### Run function
+
+- Not available until the next release of testcontainers-go <a href="https://github.com/testcontainers/testcontainers-go"><span class="tc-version">:material-tag: main</span></a>
+
+!!!info
+    The `RunContainer(ctx, opts...)` function is deprecated and will be removed in the next major release of _Testcontainers for Go_.
 
 The Dolt module exposes one entrypoint function to create the Dolt container, and this function receives three parameters:
 

docs/modules/elasticsearch.md

@@ -20,7 +20,14 @@ go get github.com/testcontainers/testcontainers-go/modules/elasticsearch
 [Creating a Elasticsearch container](../../modules/elasticsearch/examples_test.go) inside_block:runElasticsearchContainer
 <!--/codeinclude-->
 
-## Module reference
+## Module Reference
+
+### Run function
+
+- Not available until the next release of testcontainers-go <a href="https://github.com/testcontainers/testcontainers-go"><span class="tc-version">:material-tag: main</span></a>
+
+!!!info
+    The `RunContainer(ctx, opts...)` function is deprecated and will be removed in the next major release of _Testcontainers for Go_.
 
 The Elasticsearch module exposes one entrypoint function to create the Elasticsearch container, and this function receives three parameters:
 

docs/modules/gcloud.md

@@ -75,20 +75,28 @@ It's important to set the target string of the `grpc.Dial` method using the cont
 
 It's important to set the `option.WithEndpoint()` option using the container's URI, as shown in the Admin client example above.
 
-## Module reference
+## Module Reference
 
-The GCloud module exposes one entrypoint function to create the different GCloud emulators, and each function receives two parameters:
+### Run function
+
+- Not available until the next release of testcontainers-go <a href="https://github.com/testcontainers/testcontainers-go"><span class="tc-version">:material-tag: main</span></a>
+
+!!!info
+    The `RunXXXContainer(ctx, opts...)` functions are deprecated and will be removed in the next major release of _Testcontainers for Go_.
+
+The GCloud module exposes one entrypoint function to create the different GCloud emulators, and each function receives three parameters:
 
 ```golang
-func RunBigQueryContainer(ctx context.Context, opts ...testcontainers.ContainerCustomizer) (*BigQueryContainer, error)
-func RunBigTableContainer(ctx context.Context, opts ...testcontainers.ContainerCustomizer) (*BigTableContainer, error)
-func RunDatastoreContainer(ctx context.Context, opts ...testcontainers.ContainerCustomizer) (*DatastoreContainer, error)
-func RunFirestoreContainer(ctx context.Context, opts ...testcontainers.ContainerCustomizer) (*FirestoreContainer, error)
-func RunPubsubContainer(ctx context.Context, opts ...testcontainers.ContainerCustomizer) (*PubsubContainer, error)
-func RunSpannerContainer(ctx context.Context, opts ...testcontainers.ContainerCustomizer) (*SpannerContainer, error)
+func RunBigQuery(ctx context.Context, img string, opts ...testcontainers.ContainerCustomizer) (*BigQueryContainer, error)
+func RunBigTable(ctx context.Context, img string, opts ...testcontainers.ContainerCustomizer) (*BigTableContainer, error)
+func RunDatastore(ctx context.Context, img string, opts ...testcontainers.ContainerCustomizer) (*DatastoreContainer, error)
+func RunFirestore(ctx context.Context, img string, opts ...testcontainers.ContainerCustomizer) (*FirestoreContainer, error)
+func RunPubsub(ctx context.Context, img string, opts ...testcontainers.ContainerCustomizer) (*PubsubContainer, error)
+func RunSpanner(ctx context.Context, img string, opts ...testcontainers.ContainerCustomizer) (*SpannerContainer, error)
 ```
 
 - `context.Context`, the Go context.
+- `string`, the Docker image to use.
 - `testcontainers.ContainerCustomizer`, a variadic argument for passing options.
 
 ### Container Options

docs/modules/inbucket.md

@@ -20,7 +20,14 @@ go get github.com/testcontainers/testcontainers-go/modules/inbucket
 [Creating a Inbucket container](../../modules/inbucket/examples_test.go) inside_block:runInbucketContainer
 <!--/codeinclude-->
 
-## Module reference
+## Module Reference
+
+### Run function
+
+- Not available until the next release of testcontainers-go <a href="https://github.com/testcontainers/testcontainers-go"><span class="tc-version">:material-tag: main</span></a>
+
+!!!info
+    The `RunContainer(ctx, opts...)` function is deprecated and will be removed in the next major release of _Testcontainers for Go_.
 
 The Inbucket module exposes one entrypoint function to create the Inbucket container, and this function receives three parameters:
 

docs/modules/influxdb.md

@@ -22,6 +22,13 @@ go get github.com/testcontainers/testcontainers-go/modules/influxdb
 
 ## Module Reference
 
+### Run function
+
+- Not available until the next release of testcontainers-go <a href="https://github.com/testcontainers/testcontainers-go"><span class="tc-version">:material-tag: main</span></a>
+
+!!!info
+    The `RunContainer(ctx, opts...)` function is deprecated and will be removed in the next major release of _Testcontainers for Go_.
+
 The InfluxDB module exposes one entrypoint function to create the container, and this function receives three parameters:
 
 ```golang

docs/modules/k3s.md

@@ -20,7 +20,14 @@ go get github.com/testcontainers/testcontainers-go/modules/k3s
 [Test for a K3s container](../../modules/k3s/k3s_test.go) inside_block:runK3sContainer
 <!--/codeinclude-->
 
-## Module reference
+## Module Reference
+
+### Run function
+
+- Not available until the next release of testcontainers-go <a href="https://github.com/testcontainers/testcontainers-go"><span class="tc-version">:material-tag: main</span></a>
+
+!!!info
+    The `RunContainer(ctx, opts...)` function is deprecated and will be removed in the next major release of _Testcontainers for Go_.
 
 The K3s module exposes one entrypoint function to create the K3s container, and this function receives three parameters:
 
@@ -32,7 +39,6 @@ func Run(ctx context.Context, img string, opts ...testcontainers.ContainerCustom
 - `string`, the Docker image to use.
 - `testcontainers.ContainerCustomizer`, a variadic argument for passing options.
 
-
 ### Container Ports
 These are the ports used by the K3s container:
 <!--codeinclude-->

docs/modules/k6.md

@@ -27,7 +27,14 @@ go get github.com/testcontainers/testcontainers-go/modules/k6
 [Creating a K6 container](../../modules/k6/examples_test.go) inside_block:runK6Container
 <!--/codeinclude-->
 
-## Module reference
+## Module Reference
+
+### Run function
+
+- Not available until the next release of testcontainers-go <a href="https://github.com/testcontainers/testcontainers-go"><span class="tc-version">:material-tag: main</span></a>
+
+!!!info
+    The `RunContainer(ctx, opts...)` function is deprecated and will be removed in the next major release of _Testcontainers for Go_.
 
 The K6 module exposes one entrypoint function to run the K6 container, and this function receives three parameters:
 

docs/modules/kafka.md

@@ -20,7 +20,14 @@ go get github.com/testcontainers/testcontainers-go/modules/kafka
 [Creating a Kafka container](../../modules/kafka/examples_test.go) inside_block:runKafkaContainer
 <!--/codeinclude-->
 
-## Module reference
+## Module Reference
+
+### Run function
+
+- Not available until the next release of testcontainers-go <a href="https://github.com/testcontainers/testcontainers-go"><span class="tc-version">:material-tag: main</span></a>
+
+!!!info
+    The `RunContainer(ctx, opts...)` function is deprecated and will be removed in the next major release of _Testcontainers for Go_.
 
 The Kafka module exposes one entrypoint function to create the Kafka container, and this function receives three parameters:
 

docs/modules/localstack.md

@@ -25,7 +25,14 @@ Running LocalStack as a stand-in for multiple AWS services during a test:
 Environment variables listed in [Localstack's README](https://github.com/localstack/localstack#configurations) may be used to customize Localstack's configuration. 
 Use the `testcontainers.WithEnv` option when creating the `LocalStackContainer` to apply those variables.
 
-## Module reference
+## Module Reference
+
+### Run function
+
+- Not available until the next release of testcontainers-go <a href="https://github.com/testcontainers/testcontainers-go"><span class="tc-version">:material-tag: main</span></a>
+
+!!!info
+    The `RunContainer(ctx, opts...)` function is deprecated and will be removed in the next major release of _Testcontainers for Go_.
 
 The LocalStack module exposes one single function to create the LocalStack container, and this function receives three parameters:
 

docs/modules/mariadb.md

@@ -20,7 +20,14 @@ go get github.com/testcontainers/testcontainers-go/modules/mariadb
 [Creating a MariaDB container](../../modules/mariadb/examples_test.go) inside_block:runMariaDBContainer
 <!--/codeinclude-->
 
-## Module reference
+## Module Reference
+
+### Run function
+
+- Not available until the next release of testcontainers-go <a href="https://github.com/testcontainers/testcontainers-go"><span class="tc-version">:material-tag: main</span></a>
+
+!!!info
+    The `RunContainer(ctx, opts...)` function is deprecated and will be removed in the next major release of _Testcontainers for Go_.
 
 The MariaDB module exposes one entrypoint function to create the MariaDB container, and this function receives three parameters:
 

docs/modules/milvus.md

@@ -20,7 +20,14 @@ go get github.com/testcontainers/testcontainers-go/modules/milvus
 [Creating a Milvus container](../../modules/milvus/examples_test.go) inside_block:runMilvusContainer
 <!--/codeinclude-->
 
-## Module reference
+## Module Reference
+
+### Run function
+
+- Not available until the next release of testcontainers-go <a href="https://github.com/testcontainers/testcontainers-go"><span class="tc-version">:material-tag: main</span></a>
+
+!!!info
+    The `RunContainer(ctx, opts...)` function is deprecated and will be removed in the next major release of _Testcontainers for Go_.
 
 The Milvus module exposes one entrypoint function to create the Milvus container, and this function receives three parameters:
 

docs/modules/minio.md

@@ -20,7 +20,14 @@ go get github.com/testcontainers/testcontainers-go/modules/minio
 [Creating a Minio container](../../modules/minio/examples_test.go) inside_block:runMinioContainer
 <!--/codeinclude-->
 
-## Module reference
+## Module Reference
+
+### Run function
+
+- Not available until the next release of testcontainers-go <a href="https://github.com/testcontainers/testcontainers-go"><span class="tc-version">:material-tag: main</span></a>
+
+!!!info
+    The `RunContainer(ctx, opts...)` function is deprecated and will be removed in the next major release of _Testcontainers for Go_.
 
 The Minio module exposes one entrypoint function to create the Minio container, and this function receives three parameters:
 

docs/modules/mockserver.md

@@ -20,7 +20,14 @@ go get github.com/testcontainers/testcontainers-go/modules/mockserver
 [Creating a MockServer container](../../modules/mockserver/examples_test.go) inside_block:runMockServerContainer
 <!--/codeinclude-->
 
-## Module reference
+## Module Reference
+
+### Run function
+
+- Not available until the next release of testcontainers-go <a href="https://github.com/testcontainers/testcontainers-go"><span class="tc-version">:material-tag: main</span></a>
+
+!!!info
+    The `RunContainer(ctx, opts...)` function is deprecated and will be removed in the next major release of _Testcontainers for Go_.
 
 The MockServer module exposes one entrypoint function to create the MockServer container, and this function receives three parameters:
 

docs/modules/mongodb.md

@@ -20,7 +20,14 @@ go get github.com/testcontainers/testcontainers-go/modules/mongodb
 [Creating a MongoDB container](../../modules/mongodb/examples_test.go) inside_block:runMongoDBContainer
 <!--/codeinclude-->
 
-## Module reference
+## Module Reference
+
+### Run function
+
+- Not available until the next release of testcontainers-go <a href="https://github.com/testcontainers/testcontainers-go"><span class="tc-version">:material-tag: main</span></a>
+
+!!!info
+    The `RunContainer(ctx, opts...)` function is deprecated and will be removed in the next major release of _Testcontainers for Go_.
 
 The MongoDB module exposes one entrypoint function to create the MongoDB container, and this function receives three parameters: