Add a basic documentation page for RabbitMQ module (#1661)

testcontainers · Jul 24, 2019 · e95bdd5 · e95bdd5
1 parent 4604174
commit e95bdd5
Show file tree

Hide file tree

Showing 2 changed files with 25 additions and 3 deletions.
diff --git a/docs/modules/rabbitmq.md b/docs/modules/rabbitmq.md
@@ -0,0 +1,21 @@
+# RabbitMQ Module
+
+!!! note
+    This module is INCUBATING. While it is ready for use and operational in the current version of Testcontainers, it is possible that it may receive breaking changes in the future. See [our contributing guidelines](/contributing/#incubating-modules) for more information on our incubating modules policy.
+
+## Adding this module to your project dependencies
+
+Add the following dependency to your `pom.xml`/`build.gradle` file:
+
+```groovy tab='Gradle'
+testCompile "org.testcontainers:rabbitmq:{{latest_version}}"
+```
+
+```xml tab='Maven'
+<dependency>
+    <groupId>org.testcontainers</groupId>
+    <artifactId>rabbitmq</artifactId>
+    <version>{{latest_version}}</version>
+    <scope>test</scope>
+</dependency>
+```
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -51,16 +51,17 @@ nav:
                 - modules/databases/neo4j.md
                 - modules/databases/oraclexe.md
                 - modules/databases/postgres.md
-          - modules/webdriver_containers.md
           - modules/docker_compose.md
           - modules/elasticsearch.md
           - modules/kafka.md
-          - modules/pulsar.md
           - modules/localstack.md
           - modules/mockserver.md
-          - modules/toxiproxy.md
           - modules/nginx.md
+          - modules/pulsar.md
+          - modules/rabbitmq.md
+          - modules/toxiproxy.md
           - modules/vault.md
+          - modules/webdriver_containers.md
     - Test framework integration:
           - test_framework_integration/junit_4.md
           - test_framework_integration/junit_5.md