docs: have common options in a common markdown file (testcontainers#1648

) * docs: have common options in a common markdown file It will be included using a mkdocs plugin * chore: python lock file
mdelapenya · Sep 20, 2023 · e5ddd86 · e5ddd86
1 parent 76dcf05
commit e5ddd86
Show file tree

Hide file tree

Showing 24 changed files with 101 additions and 576 deletions.
diff --git a/Pipfile b/Pipfile
@@ -8,6 +8,7 @@ verify_ssl = true
 [packages]
 mkdocs = "==1.5.2"
 mkdocs-codeinclude-plugin = "==0.2.1"
+mkdocs-include-markdown-plugin = "==6.0.1"
 mkdocs-material = "==9.2.8"
 mkdocs-markdownextradata-plugin = "==0.2.5"
 

diff --git a/Pipfile.lock b/Pipfile.lock
diff --git a/docs/features/common_functional_options.md b/docs/features/common_functional_options.md
@@ -0,0 +1,31 @@
+#### Wait Strategies
+
+If you need to set a different wait strategy for the container, you can use `testcontainers.WithWaitStrategy` with a valid wait strategy.
+
+!!!info
+    The default deadline for the wait strategy is 60 seconds.
+
+At the same time, it's possible to set a wait strategy and a custom deadline with `testcontainers.WithWaitStrategyAndDeadline`.
+
+#### Startup Commands
+
+- 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>
+
+Testcontainers exposes the `WithStartupCommand(e ...Executable)` option to run arbitrary commands in the container right after it's started.
+
+!!!info
+    To better understand how this feature works, please read the [Create containers: Lifecycle Hooks](/features/creating_container/#lifecycle-hooks) documentation.
+
+It also exports an `Executable` interface, defining one single method: `AsCommand()`, which returns a slice of strings to represent the command and positional arguments to be executed in the container.
+
+You could use this feature to run a custom script, or to run a command that is not supported by the module right after the container is started.
+
+#### Docker type modifiers
+
+If you need an advanced configuration for the container, you can leverage the following Docker type modifiers:
+
+- `testcontainers.WithConfigModifier`
+- `testcontainers.WithHostConfigModifier`
+- `testcontainers.WithEndpointSettingsModifier`
+
+Please read the [Create containers: Advanced Settings](/features/creating_container.md#advanced-settings) documentation for more information.
diff --git a/docs/modules/artemis.md b/docs/modules/artemis.md
@@ -44,15 +44,7 @@ When starting the Artemis container, you can pass options in a variadic way to c
 If you need to set a different Artemis Docker image, you can use `testcontainers.WithImage` with a valid Docker image
 for Artemis. E.g. `testcontainers.WithImage("docker.io/apache/activemq-artemis:2.30.0")`.
 
-#### Wait Strategies
-
-If you need to set a different wait strategy for Artemis, you can use `testcontainers.WithWaitStrategy` with a valid wait strategy
-for Artemis.
-
-!!!info
-    The default deadline for the wait strategy is 60 seconds.
-
-At the same time, it's possible to set a wait strategy and a custom deadline with `testcontainers.WithWaitStrategyAndDeadline`.
+{% include "../features/common_functional_options.md" %}
 
 #### Credentials
 
@@ -83,30 +75,6 @@ Setting this value will override the default.
 [With Extra Arguments](../../modules/artemis/artemis_test.go) inside_block:withExtraArgs
 <!--/codeinclude-->
 
-#### Docker type modifiers
-
-If you need an advanced configuration for Artemis, you can leverage the following Docker type modifiers:
-
-- `testcontainers.WithConfigModifier`
-- `testcontainers.WithHostConfigModifier`
-- `testcontainers.WithEndpointSettingsModifier`
-
-Please read the [Create containers: Advanced Settings](../features/creating_container.md#advanced-settings) documentation for more information.
-
-#### Startup Commands
-
-!!!info
-    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>
-
-Testcontainers exposes the `WithStartupCommand(e ...Executable)` option to run arbitrary commands in the container right after it's started.
-
-!!!info
-    To better understand how this feature works, please read the [Create containers: Lifecycle Hooks](../../features/creating_container/#lifecycle-hooks) documentation.
-
-It also exports an `Executable` interface, defining one single method: `AsCommand()`, which returns a slice of strings to represent the command and positional arguments to be executed in the container.
-
-You could use this feature to run a custom script, or to run a command that is not supported by the module right after the Artemis container is started.
-
 ### Container Methods
 
 The Artemis container exposes the following methods:

diff --git a/docs/modules/clickhouse.md b/docs/modules/clickhouse.md
@@ -48,39 +48,7 @@ When starting the ClickHouse container, you can pass options in a variadic way t
 If you need to set a different ClickHouse Docker image, you can use `testcontainers.WithImage` with a valid Docker image
 for ClickHouse. E.g. `testcontainers.WithImage("clickhouse/clickhouse-server:23.3.8.21-alpine")`.
 
-#### Wait Strategies
-
-If you need to set a different wait strategy for ClickHouse, you can use `testcontainers.WithWaitStrategy` with a valid wait strategy
-for ClickHouse.
-
-!!!info
-    The default deadline for the wait strategy is 60 seconds.
-
-At the same time, it's possible to set a wait strategy and a custom deadline with `testcontainers.WithWaitStrategyAndDeadline`.
-
-#### Docker type modifiers
-
-If you need an advanced configuration for ClickHouse, you can leverage the following Docker type modifiers:
-
-- `testcontainers.WithConfigModifier`
-- `testcontainers.WithHostConfigModifier`
-- `testcontainers.WithEndpointSettingsModifier`
-
-Please read the [Create containers: Advanced Settings](../features/creating_container.md#advanced-settings) documentation for more information.
-
-#### Startup Commands
-
-!!!info
-    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>
-
-Testcontainers exposes the `WithStartupCommand(e ...Executable)` option to run arbitrary commands in the container right after it's started.
-
-!!!info
-    To better understand how this feature works, please read the [Create containers: Lifecycle Hooks](../../features/creating_container/#lifecycle-hooks) documentation.
-
-It also exports an `Executable` interface, defining one single method: `AsCommand()`, which returns a slice of strings to represent the command and positional arguments to be executed in the container.
-
-You could use this feature to run a custom script, or to run a command that is not supported by the module right after the ClickHouse container is started.
+{% include "../features/common_functional_options.md" %}
 
 #### Set username, password and database name
 

diff --git a/docs/modules/couchbase.md b/docs/modules/couchbase.md
@@ -79,39 +79,7 @@ You can find the Docker images that are currently tested in this module, for the
 [Docker images](../../modules/couchbase/couchbase_test.go) inside_block:dockerImages
 <!--/codeinclude-->
 
-#### Wait Strategies
-
-If you need to set a different wait strategy for Couchbase, you can use `testcontainers.WithWaitStrategy` with a valid wait strategy
-for Couchbase.
-
-!!!info
-    The default deadline for the wait strategy is 60 seconds.
-
-At the same time, it's possible to set a wait strategy and a custom deadline with `testcontainers.WithWaitStrategyAndDeadline`.
-
-#### Docker type modifiers
-
-If you need an advanced configuration for Couchbase, you can leverage the following Docker type modifiers:
-
-- `testcontainers.WithConfigModifier`
-- `testcontainers.WithHostConfigModifier`
-- `testcontainers.WithEndpointSettingsModifier`
-
-Please read the [Create containers: Advanced Settings](../features/creating_container.md#advanced-settings) documentation for more information.
-
-#### Startup Commands
-
-!!!info
-    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>
-
-Testcontainers exposes the `WithStartupCommand(e ...Executable)` option to run arbitrary commands in the container right after it's started.
-
-!!!info
-    To better understand how this feature works, please read the [Create containers: Lifecycle Hooks](../../features/creating_container/#lifecycle-hooks) documentation.
-
-It also exports an `Executable` interface, defining one single method: `AsCommand()`, which returns a slice of strings to represent the command and positional arguments to be executed in the container.
-
-You could use this feature to run a custom script, or to run a command that is not supported by the module right after the Couchbase container is started.
+{% include "../features/common_functional_options.md" %}
 
 #### Credentials
 

diff --git a/docs/modules/elasticsearch.md b/docs/modules/elasticsearch.md
@@ -40,39 +40,7 @@ When starting the Elasticsearch container, you can pass options in a variadic wa
 If you need to set a different Elasticsearch Docker image, you can use `testcontainers.WithImage` with a valid Docker image
 for Elasticsearch. E.g. `testcontainers.WithImage("docker.elastic.co/elasticsearch/elasticsearch:8.0.0")`.
 
-#### Wait Strategies
-
-If you need to set a different wait strategy for Elasticsearch, you can use `testcontainers.WithWaitStrategy` with a valid wait strategy
-for Elasticsearch.
-
-!!!info
-    The default deadline for the wait strategy is 60 seconds.
-
-At the same time, it's possible to set a wait strategy and a custom deadline with `testcontainers.WithWaitStrategyAndDeadline`.
-
-#### Docker type modifiers
-
-If you need an advanced configuration for Elasticsearch, you can leverage the following Docker type modifiers:
-
-- `testcontainers.WithConfigModifier`
-- `testcontainers.WithHostConfigModifier`
-- `testcontainers.WithEndpointSettingsModifier`
-
-Please read the [Create containers: Advanced Settings](../features/creating_container.md#advanced-settings) documentation for more information.
-
-#### Startup Commands
-
-!!!info
-    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>
-
-Testcontainers exposes the `WithStartupCommand(e ...Executable)` option to run arbitrary commands in the container right after it's started.
-
-!!!info
-    To better understand how this feature works, please read the [Create containers: Lifecycle Hooks](../../features/creating_container/#lifecycle-hooks) documentation.
-
-It also exports an `Executable` interface, defining one single method: `AsCommand()`, which returns a slice of strings to represent the command and positional arguments to be executed in the container.
-
-You could use this feature to run a custom script, or to run a command that is not supported by the module right after the Elasticsearch container is started.
+{% include "../features/common_functional_options.md" %}
 
 #### Elasticsearch password