Skip to content

Commit d1a3bc5

Browse files
committed
resource/gitlab_service_pipelines_email: Improve documentation and reference upstream docs
1 parent 7a9b480 commit d1a3bc5

File tree

2 files changed

+8
-3
lines changed

2 files changed

+8
-3
lines changed

docs/resources/service_pipelines_email.md

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,12 +3,15 @@
33
page_title: "gitlab_service_pipelines_email Resource - terraform-provider-gitlab"
44
subcategory: ""
55
description: |-
6-
This resource manages a Pipelines email integration https://docs.gitlab.com/ee/user/project/integrations/overview.html#integrations-listing that emails the pipeline status to a list of recipients.
6+
The gitlab_service_pipelines_email resource allows to manage the lifecycle of a project integration with Pipeline Emails Service.
7+
Upstream API: GitLab REST API docs https://docs.gitlab.com/ee/api/integrations.html#pipeline-emails
78
---
89

910
# gitlab_service_pipelines_email (Resource)
1011

11-
This resource manages a [Pipelines email integration](https://docs.gitlab.com/ee/user/project/integrations/overview.html#integrations-listing) that emails the pipeline status to a list of recipients.
12+
The `gitlab_service_pipelines_email` resource allows to manage the lifecycle of a project integration with Pipeline Emails Service.
13+
14+
**Upstream API**: [GitLab REST API docs](https://docs.gitlab.com/ee/api/integrations.html#pipeline-emails)
1215

1316
## Example Usage
1417

internal/provider/resource_gitlab_service_pipelines_email.go

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,9 @@ import (
1313

1414
var _ = registerResource("gitlab_service_pipelines_email", func() *schema.Resource {
1515
return &schema.Resource{
16-
Description: "This resource manages a [Pipelines email integration](https://docs.gitlab.com/ee/user/project/integrations/overview.html#integrations-listing) that emails the pipeline status to a list of recipients.",
16+
Description: `The ` + "`gitlab_service_pipelines_email`" + ` resource allows to manage the lifecycle of a project integration with Pipeline Emails Service.
17+
18+
**Upstream API**: [GitLab REST API docs](https://docs.gitlab.com/ee/api/integrations.html#pipeline-emails)`,
1719

1820
CreateContext: resourceGitlabServicePipelinesEmailCreate,
1921
ReadContext: resourceGitlabServicePipelinesEmailRead,

0 commit comments

Comments
 (0)