Skip to content

Commit 2513e2a

Browse files
committed
resource/gitlab_service_github: Improve documentation and reference upstream docs
1 parent dba3800 commit 2513e2a

File tree

2 files changed

+12
-6
lines changed

2 files changed

+12
-6
lines changed

docs/resources/service_github.md

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3,15 +3,18 @@
33
page_title: "gitlab_service_github Resource - terraform-provider-gitlab"
44
subcategory: ""
55
description: |-
6-
NOTE: requires either EE (self-hosted) or Silver and above (GitLab.com).
7-
This resource manages a GitHub integration https://docs.gitlab.com/ee/user/project/integrations/github.html that updates pipeline statuses on a GitHub repo's pull requests.
6+
The gitlab_service_github resource allows to manage the lifecycle of a project integration with GitHub.
7+
-> This resource requires a GitLab Enterprise instance.
8+
Upstream API: GitLab REST API docs https://docs.gitlab.com/ee/api/integrations.html#github
89
---
910

1011
# gitlab_service_github (Resource)
1112

12-
**NOTE**: requires either EE (self-hosted) or Silver and above (GitLab.com).
13+
The `gitlab_service_github` resource allows to manage the lifecycle of a project integration with GitHub.
1314

14-
This resource manages a [GitHub integration](https://docs.gitlab.com/ee/user/project/integrations/github.html) that updates pipeline statuses on a GitHub repo's pull requests.
15+
-> This resource requires a GitLab Enterprise instance.
16+
17+
**Upstream API**: [GitLab REST API docs](https://docs.gitlab.com/ee/api/integrations.html#github)
1518

1619
## Example Usage
1720

internal/provider/resource_gitlab_service_github.go

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,8 +12,11 @@ import (
1212

1313
var _ = registerResource("gitlab_service_github", func() *schema.Resource {
1414
return &schema.Resource{
15-
Description: "**NOTE**: requires either EE (self-hosted) or Silver and above (GitLab.com).\n\n" +
16-
"This resource manages a [GitHub integration](https://docs.gitlab.com/ee/user/project/integrations/github.html) that updates pipeline statuses on a GitHub repo's pull requests.",
15+
Description: `The ` + "`gitlab_service_github`" + ` resource allows to manage the lifecycle of a project integration with GitHub.
16+
17+
-> This resource requires a GitLab Enterprise instance.
18+
19+
**Upstream API**: [GitLab REST API docs](https://docs.gitlab.com/ee/api/integrations.html#github)`,
1720

1821
CreateContext: resourceGitlabServiceGithubCreate,
1922
ReadContext: resourceGitlabServiceGithubRead,

0 commit comments

Comments
 (0)