Skip to content

Commit 9924800

Browse files
committed
resource/gitlab_project_mirror: Improve documentation and reference upstream docs
1 parent 9f30760 commit 9924800

File tree

2 files changed

+14
-15
lines changed

2 files changed

+14
-15
lines changed

docs/resources/project_mirror.md

Lines changed: 8 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -3,22 +3,20 @@
33
page_title: "gitlab_project_mirror Resource - terraform-provider-gitlab"
44
subcategory: ""
55
description: |-
6-
This resource allows you to add a mirror target for the repository, all changes will be synced to the remote target.
7-
-> This is for pushing changes to a remote repository. Pull Mirroring can be configured using a combination of the
8-
import_url, mirror, and mirror_trigger_builds properties on the gitlab_project resource.
9-
For further information on mirroring, consult the
10-
gitlab documentation https://docs.gitlab.com/ee/user/project/repository/repository_mirroring.html#repository-mirroring.
6+
The gitlab_project_mirror resource allows to manage the lifecycle of a project mirror.
7+
This is for pushing changes to a remote repository. Pull Mirroring can be configured using a combination of the
8+
importurl, mirror, and mirrortriggerbuilds properties on the gitlabproject resource.
9+
Upstream API: GitLab REST API docs https://docs.gitlab.com/ee/api/remote_mirrors.html
1110
---
1211

1312
# gitlab_project_mirror (Resource)
1413

15-
This resource allows you to add a mirror target for the repository, all changes will be synced to the remote target.
14+
The `gitlab_project_mirror` resource allows to manage the lifecycle of a project mirror.
1615

17-
-> This is for *pushing* changes to a remote repository. *Pull Mirroring* can be configured using a combination of the
18-
`import_url`, `mirror`, and `mirror_trigger_builds` properties on the `gitlab_project` resource.
16+
This is for *pushing* changes to a remote repository. *Pull Mirroring* can be configured using a combination of the
17+
import_url, mirror, and mirror_trigger_builds properties on the gitlab_project resource.
1918

20-
For further information on mirroring, consult the
21-
[gitlab documentation](https://docs.gitlab.com/ee/user/project/repository/repository_mirroring.html#repository-mirroring).
19+
**Upstream API**: [GitLab REST API docs](https://docs.gitlab.com/ee/api/remote_mirrors.html)
2220

2321
## Example Usage
2422

internal/provider/resource_gitlab_project_mirror.go

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -14,11 +14,12 @@ import (
1414

1515
var _ = registerResource("gitlab_project_mirror", func() *schema.Resource {
1616
return &schema.Resource{
17-
Description: "This resource allows you to add a mirror target for the repository, all changes will be synced to the remote target.\n\n" +
18-
"-> This is for *pushing* changes to a remote repository. *Pull Mirroring* can be configured using a combination of the\n" +
19-
"`import_url`, `mirror`, and `mirror_trigger_builds` properties on the `gitlab_project` resource.\n\n" +
20-
"For further information on mirroring, consult the\n" +
21-
"[gitlab documentation](https://docs.gitlab.com/ee/user/project/repository/repository_mirroring.html#repository-mirroring).",
17+
Description: `The ` + "`" + `gitlab_project_mirror` + "`" + ` resource allows to manage the lifecycle of a project mirror.
18+
19+
This is for *pushing* changes to a remote repository. *Pull Mirroring* can be configured using a combination of the
20+
import_url, mirror, and mirror_trigger_builds properties on the gitlab_project resource.
21+
22+
**Upstream API**: [GitLab REST API docs](https://docs.gitlab.com/ee/api/remote_mirrors.html)`,
2223

2324
CreateContext: resourceGitlabProjectMirrorCreate,
2425
ReadContext: resourceGitlabProjectMirrorRead,

0 commit comments

Comments
 (0)