docs: add template for index.md

This commit is contained in:
Manuel Vogel 2021-05-13 08:50:59 +02:00
parent 208b733bae
commit 683c437b59
No known key found for this signature in database
GPG key ID: 24E54F214569A8A5
2 changed files with 33 additions and 6 deletions

View file

@ -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

22
templates/index.md.tmpl Normal file
View file

@ -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 }}