diff --git a/docs/index.md b/docs/index.md index 20f9ddeb..a469f73e 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1,14 +1,19 @@ --- -# generated by https://github.com/hashicorp/terraform-plugin-docs -page_title: "docker Provider" -subcategory: "" +layout: "" +page_title: "Provider: Docker" description: |- - + The Docker provider is used to interact with Docker containers and images. --- -# docker Provider +# Docker Provider +The Docker provider is used to interact with Docker containers and images. +It uses the Docker API to manage the lifecycle of Docker containers. Because +the Docker provider uses the Docker API, it is immediately compatible not +only with single server Docker but Swarm and any additional Docker-compatible +API hosts. +Use the navigation to the left to read about the available resources. ## Example Usage @@ -52,4 +57,4 @@ Optional: - **config_file** (String) Path to docker json file for registry auth - **config_file_content** (String) Plain content of the docker json file for registry auth - **password** (String, Sensitive) Password for the registry -- **username** (String) Username for the registry +- **username** (String) Username for the registry \ No newline at end of file diff --git a/templates/index.md.tmpl b/templates/index.md.tmpl new file mode 100644 index 00000000..6b118e0f --- /dev/null +++ b/templates/index.md.tmpl @@ -0,0 +1,22 @@ +--- +layout: "" +page_title: "Provider: Docker" +description: |- + The Docker provider is used to interact with Docker containers and images. +--- + +# Docker Provider + +The Docker provider is used to interact with Docker containers and images. +It uses the Docker API to manage the lifecycle of Docker containers. Because +the Docker provider uses the Docker API, it is immediately compatible not +only with single server Docker but Swarm and any additional Docker-compatible +API hosts. + +Use the navigation to the left to read about the available resources. + +## Example Usage + +{{tffile "examples/provider/provider.tf"}} + +{{ .SchemaMarkdown | trimspace }} \ No newline at end of file