Add samples section (#5763)

List examples provided in testcontainers by providing an specific
section in the docs.

Co-authored-by: Kevin Wittek <[email protected]>

Author: eddumelendez

docs/examples.md

@@ -0,0 +1,16 @@
+# Examples
+
+Examples of different use cases provided by Testcontainers can be found below:
+
+- [Kafka Cluster with multiple brokers](https://github.com/testcontainers/testcontainers-java/tree/master/examples/kafka-cluster)
+- [Linked containers](https://github.com/testcontainers/testcontainers-java/tree/master/examples/linked-container)
+- [MongoDB](https://github.com/testcontainers/testcontainers-java/tree/master/examples/mongodb-container)
+- [Neo4j](https://github.com/testcontainers/testcontainers-java/tree/master/examples/neo4j-container)
+- [Redis](https://github.com/testcontainers/testcontainers-java/tree/master/examples/redis-backed-cache)
+- [Selenium](https://github.com/testcontainers/testcontainers-java/tree/master/examples/cucumber)
+- [Selenium Module with Cucumber](https://github.com/testcontainers/testcontainers-java/tree/master/examples/cucumber)
+- [Singleton Container Pattern](https://github.com/testcontainers/testcontainers-java/tree/master/examples/singleton-container)
+- [Solr](https://github.com/testcontainers/testcontainers-java/tree/master/examples/solr-container)
+- [Spring Boot](https://github.com/testcontainers/testcontainers-java/tree/master/examples/spring-boot)
+- [Spring Boot with Kotlin](https://github.com/testcontainers/testcontainers-java/tree/master/examples/spring-boot-kotlin-redis)
+- [TestNG](https://github.com/testcontainers/testcontainers-java/tree/master/examples/redis-backed-cache-testng)

mkdocs.yml

@@ -88,6 +88,7 @@ nav:
           - test_framework_integration/junit_5.md
           - test_framework_integration/spock.md
           - test_framework_integration/manual_lifecycle_control.md
+    - Examples: examples.md
     - System Requirements:
           - supported_docker_environment/index.md
           - Continuous Integration: