Merge branch 'main' into docker-credentials

* main:
  docs: add social links in the website (testcontainers#890)
  Update docs link for tc-node (testcontainers#878)
  fix: update modules path in generator (testcontainers#877)

docs/css/extra.css

@@ -47,4 +47,71 @@ body .card-grid-item:focus {
 .card-grid-item[href]:focus {
     background: #F2F4FE;
     color: var(--md-primary-fg-color);
-}
+}
+
+.community-callout-wrapper {
+    padding: 30px 10px 0 10px;
+}
+
+.community-callout {
+    color: #F2F4FE;
+    background: linear-gradient(10.88deg, rgba(102, 56, 242, 0.4) 9.56%, #6638F2 100%), #291A3F;
+    box-shadow: 0px 20px 45px rgba(#9991B5, 0.75);
+    border-radius: 10px;
+    padding: 20px;
+}
+
+.community-callout h2 {
+    font-size: 1.15em;
+    margin: 0 0 20px 0;
+    color: #F2F4FE;
+    text-align: center;
+}
+
+.community-callout ul {
+    list-style: none;
+    padding: 0;
+    display: flex;
+    justify-content: space-between;
+    gap: 10px;
+    margin-top: 20px;
+    margin-bottom: 0;
+}
+
+.community-callout a {
+    transition: opacity 0.2s ease;
+}
+
+.community-callout a:hover {
+    opacity: 0.5;
+}
+
+.community-callout a img {
+    height: 1.75em;
+    width: auto;
+    aspect-ratio: 1;
+}
+
+@media (min-width: 1220px) {
+    .community-callout-wrapper {
+       padding: 40px 0 0;
+    }
+
+    .community-callout h2 {
+        font-size: 1.25em;
+    }
+
+    .community-callout a img {
+        height: 2em;
+    }
+}
+
+@media (min-width: 1600px) {
+    .community-callout h2 {
+        font-size: 1.15em;
+    }
+
+    .community-callout a img {
+        height: 1.75em;
+    }
+}

docs/index.md

@@ -8,7 +8,7 @@
     <a class="card-grid-item"><img src="language-logos/go.svg"/>Go</a>
     <a href="https://dotnet.testcontainers.org/" class="card-grid-item"><img src="language-logos/dotnet.svg"/>.NET</a>
     <a href="https://testcontainers-python.readthedocs.io/en/latest/" class="card-grid-item"><img src="language-logos/python.svg"/>Python</a>
-    <a href="https://github.com/testcontainers/testcontainers-node" class="card-grid-item"><img src="language-logos/nodejs.svg"/>Node.js</a></a>
+    <a href="https://node.testcontainers.org/" class="card-grid-item"><img src="language-logos/nodejs.svg"/>Node.js</a></a>
     <a href="https://docs.rs/testcontainers/latest/testcontainers/" class="card-grid-item"><img src="language-logos/rust.svg"/>Rust</a>
     <a href="https://github.com/testcontainers/testcontainers-hs" class="card-grid-item"><img src="language-logos/haskell.svg"/>Haskell</a>
 </div>

docs/theme/main.html

@@ -0,0 +1,5 @@
+{% extends "base.html" %}
+
+{% block analytics %}
+<!-- Cloudflare Web Analytics --><script defer src='https://static.cloudflareinsights.com/beacon.min.js' data-cf-beacon='{"token": "e44a95720257486eab94698a6b4c6ca6"}'></script><!-- End Cloudflare Web Analytics -->
+{% endblock %}

docs/theme/partials/nav.html

@@ -0,0 +1,83 @@
+<!--
+  Copyright (c) 2016-2023 Martin Donath <martin.donath@squidfunk.com>
+  Permission is hereby granted, free of charge, to any person obtaining a copy
+  of this software and associated documentation files (the "Software"), to
+  deal in the Software without restriction, including without limitation the
+  rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
+  sell copies of the Software, and to permit persons to whom the Software is
+  furnished to do so, subject to the following conditions:
+  The above copyright notice and this permission notice shall be included in
+  all copies or substantial portions of the Software.
+  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+  IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+  FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT. IN NO EVENT SHALL THE
+  AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+  LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+  FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
+  IN THE SOFTWARE.
+-->
+
+<!-- Determine class according to configuration -->
+{% set class = "md-nav md-nav--primary" %}
+{% if "navigation.tabs" in features %}
+{% set class = class ~ " md-nav--lifted" %}
+{% endif %}
+{% if "toc.integrate" in features %}
+{% set class = class ~ " md-nav--integrated" %}
+{% endif %}
+
+<!-- Main navigation -->
+<nav class="{{ class }}" aria-label="{{ lang.t('nav') }}" data-md-level="0">
+
+    <!-- Site title -->
+    <label class="md-nav__title" for="__drawer">
+        <a href="{{ config.extra.homepage | d(nav.homepage.url, true) | url }}" title="{{ config.site_name | e }}"
+            class="md-nav__button md-logo" aria-label="{{ config.site_name }}" data-md-component="logo">
+            {% include "partials/logo.html" %}
+        </a>
+        {{ config.site_name }}
+    </label>
+
+    <!-- Repository information -->
+    {% if config.repo_url %}
+    <div class="md-nav__source">
+        {% include "partials/source.html" %}
+    </div>
+    {% endif %}
+
+    <!-- Render item list -->
+    <ul class="md-nav__list" data-md-scrollfix>
+        {% for nav_item in nav %}
+        {% set path = "__nav_" ~ loop.index %}
+        {% set level = 1 %}
+        {% include "partials/nav-item.html" %}
+        {% endfor %}
+        <li class="community-callout-wrapper">
+            <div class="community-callout">
+                <h2>Join the community</h2>
+                <ul>
+                    <li>
+                        <a href="https://slack.testcontainers.org/" target="_blank">
+                            <img src="/icons/slack.svg" alt="Slack" width="30" height="31">
+                        </a>
+                    </li>
+                    <li>
+                        <a href="https://github.com/testcontainers" target="_blank">
+                            <img src="/icons/github.svg" alt="GitHub" width="30" height="31">
+                        </a>
+                    </li>
+                    <li>
+                        <a href="https://stackoverflow.com/questions/tagged/testcontainers" target="_blank">
+                            <img src="/icons/stackoverflow.svg" alt="StackOverflow" width="26" height="31">
+                        </a>
+                    </li>
+                    <li>
+                        <a href="https://twitter.com/testcontainers" target="_blank">
+                            <img src="/icons/twitter.svg" alt="Twitter" width="37" height="31">
+                        </a>
+                    </li>
+                </ul>
+            </div>
+        </li>
+    </ul>
+</nav>

mkdocs.yml

@@ -5,6 +5,7 @@ plugins:
     - markdownextradata
 theme:
     name: material
+    custom_dir: docs/theme
     palette:
         scheme: testcontainers
     font:

modulegen/_template/ci.yml.tmpl

@@ -24,15 +24,15 @@ jobs:
         uses: actions/checkout@v3
 
       - name: modVerify
-        working-directory: ./examples/{{ $lower }}
+        working-directory: ./{{ ParentDir }}/{{ $lower }}
         run: go mod verify
 
       - name: modTidy
-        working-directory: ./examples/{{ $lower }}
+        working-directory: ./{{ ParentDir }}/{{ $lower }}
         run: make tools-tidy
 
       - name: gotestsum
-        working-directory: ./examples/{{ $lower }}
+        working-directory: ./{{ ParentDir }}/{{ $lower }}
         run: make test-unit
 
       - name: Run checker

modulegen/_template/docs_example.md.tmpl

@@ -1,9 +1,9 @@
 {{ $lower := ToLower }}{{ $title := Title }}# {{ $title }}
 
 {{ codeinclude "<!--codeinclude-->" }}
-[Creating a {{ $title }} container](../../examples/{{ $lower }}/{{ $lower }}.go)
+[Creating a {{ $title }} container](../../{{ ParentDir }}/{{ $lower }}/{{ $lower }}.go)
 {{ codeinclude "<!--/codeinclude-->" }}
 
 {{ codeinclude "<!--codeinclude-->" }}
-[Test for a {{ $title }} container](../../examples/{{ $lower }}/{{ $lower }}_test.go)
+[Test for a {{ $title }} container](../../{{ ParentDir }}/{{ $lower }}/{{ $lower }}_test.go)
 {{ codeinclude "<!--/codeinclude-->" }}

modulegen/_template/tools.go.tmpl

@@ -1,7 +1,7 @@
 //go:build tools
 // +build tools
 
-// This package contains the tool dependencies of the {{ Title }} example.
+// This package contains the tool dependencies of the {{ Title }} {{ ExampleType }}.
 
 package tools
 

modulegen/main.go

@@ -175,6 +175,7 @@ func generate(example Example, rootDir string) error {
 		"Entrypoint":    func() string { return example.Entrypoint() },
 		"ContainerName": func() string { return example.ContainerName() },
 		"ExampleType":   func() string { return example.Type() },
+		"ParentDir":     func() string { return example.ParentDir() },
 		"ToLower":       func() string { return example.Lower() },
 		"Title":         func() string { return example.Title() },
 		"codeinclude":   func(s string) template.HTML { return template.HTML(s) }, // escape HTML comments for codeinclude

modulegen/main_test.go

@@ -345,10 +345,10 @@ func assertExampleDocContent(t *testing.T, example Example, exampleDocFile strin
 	data := strings.Split(string(content), "\n")
 	assert.Equal(t, data[0], "# "+title)
 	assert.Equal(t, data[2], "<!--codeinclude-->")
-	assert.Equal(t, data[3], "[Creating a "+title+" container](../../examples/"+lower+"/"+lower+".go)")
+	assert.Equal(t, data[3], "[Creating a "+title+" container](../../"+example.ParentDir()+"/"+lower+"/"+lower+".go)")
 	assert.Equal(t, data[4], "<!--/codeinclude-->")
 	assert.Equal(t, data[6], "<!--codeinclude-->")
-	assert.Equal(t, data[7], "[Test for a "+title+" container](../../examples/"+lower+"/"+lower+"_test.go)")
+	assert.Equal(t, data[7], "[Test for a "+title+" container](../../"+example.ParentDir()+"/"+lower+"/"+lower+"_test.go)")
 	assert.Equal(t, data[8], "<!--/codeinclude-->")
 }
 
@@ -391,18 +391,13 @@ func assertExampleGithubWorkflowContent(t *testing.T, example Example, exampleWo
 	lower := example.Lower()
 	title := example.Title()
 
-	exampleType := "example"
-	if example.IsModule {
-		exampleType = "module"
-	}
-
 	data := strings.Split(string(content), "\n")
-	assert.Equal(t, "name: "+title+" "+exampleType+" pipeline", data[0])
+	assert.Equal(t, "name: "+title+" "+example.Type()+" pipeline", data[0])
 	assert.Equal(t, "  test-"+lower+":", data[9])
 	assert.Equal(t, "          go-version: ${{ matrix.go-version }}", data[19])
-	assert.Equal(t, "        working-directory: ./examples/"+lower, data[26])
-	assert.Equal(t, "        working-directory: ./examples/"+lower, data[30])
-	assert.Equal(t, "        working-directory: ./examples/"+lower, data[34])
+	assert.Equal(t, "        working-directory: ./"+example.ParentDir()+"/"+lower, data[26])
+	assert.Equal(t, "        working-directory: ./"+example.ParentDir()+"/"+lower, data[30])
+	assert.Equal(t, "        working-directory: ./"+example.ParentDir()+"/"+lower, data[34])
 	assert.Equal(t, "          paths: \"**/TEST-"+lower+"*.xml\"", data[44])
 }
 
@@ -462,6 +457,6 @@ func assertToolsGoContent(t *testing.T, example Example, tools string) {
 	assert.Nil(t, err)
 
 	data := strings.Split(string(content), "\n")
-	assert.Equal(t, data[3], "// This package contains the tool dependencies of the "+example.Title()+" example.")
+	assert.Equal(t, data[3], "// This package contains the tool dependencies of the "+example.Title()+" "+example.Type()+".")
 	assert.Equal(t, data[5], "package tools")
 }

modulegen/mkdocs.go

@@ -12,8 +12,9 @@ type MkDocsConfig struct {
 	SiteName string   `yaml:"site_name"`
 	Plugins  []string `yaml:"plugins"`
 	Theme    struct {
-		Name    string `yaml:"name"`
-		Palette struct {
+		Name      string `yaml:"name"`
+		CustomDir string `yaml:"custom_dir"`
+		Palette   struct {
 			Scheme string `yaml:"scheme"`
 		} `yaml:"palette"`
 		Font struct {