Skip to content

Commit cbfec9d

Browse files
committed
Uses resource Description for docs description
Signed-off-by: Timo Sand <timo.sand@f-secure.com>
1 parent 3e745a1 commit cbfec9d

2 files changed

Lines changed: 4 additions & 4 deletions

File tree

github/resource_github_organization_ruleset.go

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,8 @@ func resourceGithubOrganizationRuleset() *schema.Resource {
3232

3333
CustomizeDiff: resourceGithubOrganizationRulesetDiff,
3434

35+
Description: "Creates a GitHub organization ruleset.\n\nThis resource allows you to create and manage rulesets on the organization level. When applied, a new ruleset will be created. When destroyed, that ruleset will be removed.",
36+
3537
Schema: map[string]*schema.Schema{
3638
"name": {
3739
Type: schema.TypeString,

templates/resources/organization_ruleset.md.tmpl

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,12 @@
11
---
22
page_title: "{{.Name}} ({{.Type}}) - {{.RenderedProviderName}}"
33
description: |-
4-
Creates a GitHub organization ruleset.
4+
{{ $arr := split .Description "\n"}}{{ index $arr 0 | plainmarkdown | trimspace }}
55
---
66

77
# {{.Name}} ({{.Type}})
88

9-
Creates a GitHub organization ruleset.
10-
11-
This resource allows you to create and manage rulesets on the organization level. When applied, a new ruleset will be created. When destroyed, that ruleset will be removed.
9+
{{ .Description | trimspace }}
1210

1311
## Example Usage
1412

0 commit comments

Comments
 (0)