feat: add descriptions to docs

This commit is contained in:
Manuel Vogel 2021-05-16 15:44:59 +02:00
parent 58ba535b53
commit 6c0fd72257
No known key found for this signature in database
GPG key ID: 24E54F214569A8A5
16 changed files with 36 additions and 16 deletions

View file

@ -3,12 +3,12 @@
page_title: "docker_registry_image Data Source - terraform-provider-docker"
subcategory: ""
description: |-
Reads the image metadata from a Docker Registry. Used in conjunction with the docker_image resource to keep an image up to date on the latest available version of the tag.
---
# docker_registry_image (Data Source)
Reads the image metadata from a Docker Registry. Used in conjunction with the [docker_image](/docs/providers/docker/r/image.html) resource to keep an image up to date on the latest available version of the tag.

View file

@ -3,12 +3,12 @@
page_title: "docker_config Resource - terraform-provider-docker"
subcategory: ""
description: |-
Manages the configs of a Docker service in a swarm.
---
# docker_config (Resource)
Manages the configs of a Docker service in a swarm.
## Example Usage

View file

@ -3,12 +3,12 @@
page_title: "docker_container Resource - terraform-provider-docker"
subcategory: ""
description: |-
Manages the lifecycle of a Docker container.
---
# docker_container (Resource)
Manages the lifecycle of a Docker container.
## Example Usage

View file

@ -3,12 +3,14 @@
page_title: "docker_image Resource - terraform-provider-docker"
subcategory: ""
description: |-
Pulls a Docker image to a given Docker host from a Docker Registry.
This resource will not pull new layers of the image automatically unless used i conjunction with [docker_registry_image](/docs/providers/docker/d/registry_image.html data source to update the pull_triggers field.
---
# docker_image (Resource)
Pulls a Docker image to a given Docker host from a Docker Registry.
This resource will *not* pull new layers of the image automatically unless used i conjunction with [`docker_registry_image`](/docs/providers/docker/d/registry_image.html data source to update the `pull_triggers` field.
## Example Usage

View file

@ -3,12 +3,12 @@
page_title: "docker_registry_image Resource - terraform-provider-docker"
subcategory: ""
description: |-
Manages the lifecycle of docker image/tag in a registry.
---
# docker_registry_image (Resource)
Manages the lifecycle of docker image/tag in a registry.
## Example Usage

View file

@ -3,12 +3,12 @@
page_title: "docker_secret Resource - terraform-provider-docker"
subcategory: ""
description: |-
Manages the secrets of a Docker service in a swarm.
---
# docker_secret (Resource)
Manages the secrets of a Docker service in a swarm.
## Example Usage

View file

@ -3,12 +3,14 @@
page_title: "docker_service Resource - terraform-provider-docker"
subcategory: ""
description: |-
This resource manages the lifecycle of a Docker service. By default, the creation, update and delete of services are detached.
With the Converge Config the behavior of the docker cli is imitated to guarantee tha for example, all tasks of a service are running or successfully updated or to inform terraform that a service could no be updated and was successfully rolled back.
---
# docker_service (Resource)
This resource manages the lifecycle of a Docker service. By default, the creation, update and delete of services are detached.
With the [Converge Config](#convergeconfig) the behavior of the `docker cli` is imitated to guarantee tha for example, all tasks of a service are running or successfully updated or to inform `terraform` that a service could no be updated and was successfully rolled back.
## Example Usage

View file

@ -3,12 +3,12 @@
page_title: "docker_volume Resource - terraform-provider-docker"
subcategory: ""
description: |-
Creates and destroys a volume in Docker. This can be used alongside docker_container to prepare volumes that can be shared across containers.
---
# docker_volume (Resource)
Creates and destroys a volume in Docker. This can be used alongside [docker_container](/docs/providers/docker/r/container.html) to prepare volumes that can be shared across containers.
## Example Usage

View file

@ -19,6 +19,8 @@ import (
func dataSourceDockerRegistryImage() *schema.Resource {
return &schema.Resource{
Description: "Reads the image metadata from a Docker Registry. Used in conjunction with the [docker_image](/docs/providers/docker/r/image.html) resource to keep an image up to date on the latest available version of the tag.",
ReadContext: dataSourceDockerRegistryImageRead,
Schema: map[string]*schema.Schema{

View file

@ -12,6 +12,8 @@ import (
func resourceDockerConfig() *schema.Resource {
return &schema.Resource{
Description: "Manages the configs of a Docker service in a swarm.",
CreateContext: resourceDockerConfigCreate,
ReadContext: resourceDockerConfigRead,
DeleteContext: resourceDockerConfigDelete,

View file

@ -9,6 +9,8 @@ import (
func resourceDockerContainer() *schema.Resource {
return &schema.Resource{
Description: "Manages the lifecycle of a Docker container.",
CreateContext: resourceDockerContainerCreate,
ReadContext: resourceDockerContainerRead,
UpdateContext: resourceDockerContainerUpdate,

View file

@ -6,6 +6,8 @@ import (
func resourceDockerImage() *schema.Resource {
return &schema.Resource{
Description: "Pulls a Docker image to a given Docker host from a Docker Registry.\n This resource will *not* pull new layers of the image automatically unless used i conjunction with [`docker_registry_image`](/docs/providers/docker/d/registry_image.html data source to update the `pull_triggers` field.",
CreateContext: resourceDockerImageCreate,
ReadContext: resourceDockerImageRead,
UpdateContext: resourceDockerImageUpdate,

View file

@ -8,6 +8,8 @@ import (
func resourceDockerRegistryImage() *schema.Resource {
return &schema.Resource{
Description: "Manages the lifecycle of docker image/tag in a registry.",
CreateContext: resourceDockerRegistryImageCreate,
ReadContext: resourceDockerRegistryImageRead,
DeleteContext: resourceDockerRegistryImageDelete,

View file

@ -12,6 +12,8 @@ import (
func resourceDockerSecret() *schema.Resource {
return &schema.Resource{
Description: "Manages the secrets of a Docker service in a swarm.",
CreateContext: resourceDockerSecretCreate,
ReadContext: resourceDockerSecretRead,
DeleteContext: resourceDockerSecretDelete,

View file

@ -12,6 +12,8 @@ import (
// https://docs.docker.com/engine/api/v1.32/#operation/ServiceCreate
func resourceDockerService() *schema.Resource {
return &schema.Resource{
Description: "This resource manages the lifecycle of a Docker service. By default, the creation, update and delete of services are detached.\n With the [Converge Config](#convergeconfig) the behavior of the `docker cli` is imitated to guarantee tha for example, all tasks of a service are running or successfully updated or to inform `terraform` that a service could no be updated and was successfully rolled back.",
CreateContext: resourceDockerServiceCreate,
ReadContext: resourceDockerServiceRead,
UpdateContext: resourceDockerServiceUpdate,

View file

@ -21,6 +21,8 @@ const (
func resourceDockerVolume() *schema.Resource {
return &schema.Resource{
Description: "Creates and destroys a volume in Docker. This can be used alongside [docker_container](/docs/providers/docker/r/container.html) to prepare volumes that can be shared across containers.",
CreateContext: resourceDockerVolumeCreate,
ReadContext: resourceDockerVolumeRead,
DeleteContext: resourceDockerVolumeDelete,