From 6c0fd7225705854fbb16ae63769a2e3eb7e82e10 Mon Sep 17 00:00:00 2001 From: Manuel Vogel Date: Sun, 16 May 2021 15:44:59 +0200 Subject: [PATCH] feat: add descriptions to docs --- docs/data-sources/registry_image.md | 4 ++-- docs/resources/config.md | 4 ++-- docs/resources/container.md | 4 ++-- docs/resources/image.md | 6 ++++-- docs/resources/registry_image.md | 4 ++-- docs/resources/secret.md | 4 ++-- docs/resources/service.md | 6 ++++-- docs/resources/volume.md | 4 ++-- internal/provider/data_source_docker_registry_image.go | 2 ++ internal/provider/resource_docker_config.go | 2 ++ internal/provider/resource_docker_container.go | 2 ++ internal/provider/resource_docker_image.go | 2 ++ internal/provider/resource_docker_registry_image.go | 2 ++ internal/provider/resource_docker_secret.go | 2 ++ internal/provider/resource_docker_service.go | 2 ++ internal/provider/resource_docker_volume.go | 2 ++ 16 files changed, 36 insertions(+), 16 deletions(-) diff --git a/docs/data-sources/registry_image.md b/docs/data-sources/registry_image.md index c65e898c..7461151e 100644 --- a/docs/data-sources/registry_image.md +++ b/docs/data-sources/registry_image.md @@ -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. diff --git a/docs/resources/config.md b/docs/resources/config.md index 473fef83..a7170843 100644 --- a/docs/resources/config.md +++ b/docs/resources/config.md @@ -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 diff --git a/docs/resources/container.md b/docs/resources/container.md index d04ff433..368588ad 100644 --- a/docs/resources/container.md +++ b/docs/resources/container.md @@ -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 diff --git a/docs/resources/image.md b/docs/resources/image.md index 59a5608b..4433e8ec 100644 --- a/docs/resources/image.md +++ b/docs/resources/image.md @@ -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 diff --git a/docs/resources/registry_image.md b/docs/resources/registry_image.md index 615da4c7..484ff47e 100644 --- a/docs/resources/registry_image.md +++ b/docs/resources/registry_image.md @@ -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 diff --git a/docs/resources/secret.md b/docs/resources/secret.md index 4195eb55..76830e2d 100644 --- a/docs/resources/secret.md +++ b/docs/resources/secret.md @@ -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 diff --git a/docs/resources/service.md b/docs/resources/service.md index 36b90fa8..0d29c8f4 100644 --- a/docs/resources/service.md +++ b/docs/resources/service.md @@ -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 diff --git a/docs/resources/volume.md b/docs/resources/volume.md index ccf661f7..615e1e46 100644 --- a/docs/resources/volume.md +++ b/docs/resources/volume.md @@ -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 diff --git a/internal/provider/data_source_docker_registry_image.go b/internal/provider/data_source_docker_registry_image.go index 1a971d29..a1aa3d5f 100644 --- a/internal/provider/data_source_docker_registry_image.go +++ b/internal/provider/data_source_docker_registry_image.go @@ -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{ diff --git a/internal/provider/resource_docker_config.go b/internal/provider/resource_docker_config.go index ba6ad6b1..587ee58f 100644 --- a/internal/provider/resource_docker_config.go +++ b/internal/provider/resource_docker_config.go @@ -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, diff --git a/internal/provider/resource_docker_container.go b/internal/provider/resource_docker_container.go index 8f0ed774..7d66082b 100644 --- a/internal/provider/resource_docker_container.go +++ b/internal/provider/resource_docker_container.go @@ -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, diff --git a/internal/provider/resource_docker_image.go b/internal/provider/resource_docker_image.go index 6e977384..e821e246 100644 --- a/internal/provider/resource_docker_image.go +++ b/internal/provider/resource_docker_image.go @@ -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, diff --git a/internal/provider/resource_docker_registry_image.go b/internal/provider/resource_docker_registry_image.go index ee3f69ab..581b85b4 100644 --- a/internal/provider/resource_docker_registry_image.go +++ b/internal/provider/resource_docker_registry_image.go @@ -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, diff --git a/internal/provider/resource_docker_secret.go b/internal/provider/resource_docker_secret.go index 3bf353c3..17c37c8f 100644 --- a/internal/provider/resource_docker_secret.go +++ b/internal/provider/resource_docker_secret.go @@ -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, diff --git a/internal/provider/resource_docker_service.go b/internal/provider/resource_docker_service.go index 88105d0a..138052f5 100644 --- a/internal/provider/resource_docker_service.go +++ b/internal/provider/resource_docker_service.go @@ -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, diff --git a/internal/provider/resource_docker_volume.go b/internal/provider/resource_docker_volume.go index 331e1e1a..73ed3b85 100644 --- a/internal/provider/resource_docker_volume.go +++ b/internal/provider/resource_docker_volume.go @@ -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,