Skip to content

Commit e5d9b5d

Browse files
committed
resource/gitlab_topic: Improve documentation and reference upstream docs
1 parent 93105bc commit e5d9b5d

File tree

2 files changed

+13
-7
lines changed

2 files changed

+13
-7
lines changed

docs/resources/topic.md

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3,19 +3,22 @@
33
page_title: "gitlab_topic Resource - terraform-provider-gitlab"
44
subcategory: ""
55
description: |-
6-
This resource allows you to create and manage topics that are then assignable to projects. Topics are the successors for project tags. Aside from avoiding terminology collisions with Git tags, they are more descriptive and better searchable.
7-
For assigning topics, use the project ./project.md resource.
6+
The gitlab_topic resource allows to manage the lifecycle of topics that are then assignable to projects.
7+
Topics are the successors for project tags. Aside from avoiding terminology collisions with Git tags, they are more descriptive and better searchable.
88
~> Deleting a resource doesn't delete the corresponding topic as the GitLab API doesn't support deleting topics yet. You can set soft_destroy to true if you want the topics description to be emptied instead.
9+
Upstream API: GitLab REST API docs for topics https://docs.gitlab.com/ee/api/topics.html
910
---
1011

1112
# gitlab_topic (Resource)
1213

13-
This resource allows you to create and manage topics that are then assignable to projects. Topics are the successors for project tags. Aside from avoiding terminology collisions with Git tags, they are more descriptive and better searchable.
14+
The `gitlab_topic` resource allows to manage the lifecycle of topics that are then assignable to projects.
1415

15-
For assigning topics, use the [project](./project.md) resource.
16+
Topics are the successors for project tags. Aside from avoiding terminology collisions with Git tags, they are more descriptive and better searchable.
1617

1718
~> Deleting a resource doesn't delete the corresponding topic as the GitLab API doesn't support deleting topics yet. You can set soft_destroy to true if you want the topics description to be emptied instead.
1819

20+
**Upstream API**: [GitLab REST API docs for topics](https://docs.gitlab.com/ee/api/topics.html)
21+
1922
## Example Usage
2023

2124
```terraform

internal/provider/resource_gitlab_topic.go

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -13,11 +13,14 @@ import (
1313

1414
var _ = registerResource("gitlab_topic", func() *schema.Resource {
1515
return &schema.Resource{
16-
Description: `This resource allows you to create and manage topics that are then assignable to projects. Topics are the successors for project tags. Aside from avoiding terminology collisions with Git tags, they are more descriptive and better searchable.
16+
Description: `The ` + "`gitlab_topic`" + ` resource allows to manage the lifecycle of topics that are then assignable to projects.
1717
18-
For assigning topics, use the [project](./project.md) resource.
18+
Topics are the successors for project tags. Aside from avoiding terminology collisions with Git tags, they are more descriptive and better searchable.
1919
20-
~> Deleting a resource doesn't delete the corresponding topic as the GitLab API doesn't support deleting topics yet. You can set soft_destroy to true if you want the topics description to be emptied instead.`,
20+
~> Deleting a resource doesn't delete the corresponding topic as the GitLab API doesn't support deleting topics yet. You can set soft_destroy to true if you want the topics description to be emptied instead.
21+
22+
**Upstream API**: [GitLab REST API docs for topics](https://docs.gitlab.com/ee/api/topics.html)
23+
`,
2124

2225
CreateContext: resourceGitlabTopicCreate,
2326
ReadContext: resourceGitlabTopicRead,

0 commit comments

Comments
 (0)