Redo of documentation with mkdocs (#1150)

Author: rnorth

.envrc

@@ -0,0 +1 @@
+use python 3.6.0

.gitignore

@@ -55,3 +55,11 @@ out/
 **/.settings
 **/bin/
 **/out/
+
+# Generated docs
+site/
+.direnv/
+src/mkdocs-codeinclude-plugin
+src/pip-delete-this-directory.txt
+
+.DS_Store

LICENSE

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2015 Richard North
+Copyright (c) 2015-2019 Richard North
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal
@@ -18,4 +18,4 @@ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. 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.
+SOFTWARE.

Pipfile

@@ -0,0 +1,15 @@
+[[source]]
+name = "pypi"
+url = "https://pypi.org/simple"
+verify_ssl = true
+
+[dev-packages]
+
+[packages]
+mkdocs = "*"
+mkdocs-codeinclude-plugin = {editable = true,git = "https://github.com/rnorth/mkdocs-codeinclude-plugin"}
+mkdocs-material = "*"
+mkdocs-markdownextradata-plugin = "*"
+
+[requires]
+python_version = "3.7"

Pipfile.lock

@@ -22,7 +22,7 @@ subprojects {
     compileJava.options.encoding = 'UTF-8'
 
     lombok {
-	    version = '1.18.2'
+        version = '1.18.2'
     }
 
     task delombok(type: io.franzbecker.gradle.lombok.task.DelombokTask) {

book.js

@@ -0,0 +1,21 @@
+# Each redirect rule must be listed on a separate line, with the original path followed by the new path or URL.
+
+/usage/docker_compose.html              /modules/docker_compose/
+/usage/generic_containers.html          /features/creating_container/
+/usage/windows_support.html             /supported_docker_environment/windows/
+/usage/dockerfile.html                  /features/creating_images/
+/usage/inside_docker.html               /supported_docker_environment/continuous_integration/dind_patterns/
+/usage/webdriver_containers.html        /modules/webdriver_containers/
+/usage/properties.html                  /features/configuration/
+/usage/kafka_containers.html            /modules/kafka/
+/usage/elasticsearch_container.html     /modules/elasticsearch/
+/usage/database_containers.html         /modules/databases/
+/usage/neo4j_container.html             /modules/databases/neo4j/
+/compatibility.html                     /supported_docker_environment/
+
+# No great 1:1 mapping exists for the following, so redirect to somewhere where at least a sensible sidebar will be shown
+
+/usage/options.html                     /features/creating_container/
+/ci/ci.html                             /supported_docker_environment/
+/usage.html                             /
+

build.gradle

@@ -0,0 +1,12 @@
+# Contributing
+
+* Star the project on [Github](https://github.com/testcontainers/testcontainers-java) and help spread the word :)
+* Join our [Slack group](http://slack.testcontainers.org)
+* [Post an issue](https://github.com/testcontainers/testcontainers-java/issues) if you find any bugs
+* Contribute improvements or fixes using a [Pull Request](https://github.com/testcontainers/testcontainers-java/pulls). If you're going to contribute, thank you! Please just be sure to:
+    * discuss with the authors on an issue ticket prior to doing anything big
+    * follow the style, naming and structure conventions of the rest of the project
+    * make commits atomic and easy to merge
+    * when updating documentation, please see [our guidance for documentation contributions](contributing_docs.md).
+    * verify all tests are passing. Build the project with `./gradlew check` to do this.
+    **N.B.** Gradle's Build Cache is enabled by default, but you can add `--no-build-cache` flag to disable it.