Skip to content

Commit 5fb9e92

Browse files
Fix stack docs missing some placeholders (#1376)
Closes #1370
1 parent 9b37ce0 commit 5fb9e92

File tree

3 files changed

+6
-8
lines changed

3 files changed

+6
-8
lines changed

docs/data-sources/cloud_stack.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,7 @@ available at “https://<stack_slug>.grafana.net".
5050
- `logs_status` (String)
5151
- `logs_url` (String)
5252
- `logs_user_id` (Number)
53-
- `name` (String) Name of stack. Conventionally matches the url of the instance (e.g. <stack_slug>.grafana.net).
53+
- `name` (String) Name of stack. Conventionally matches the url of the instance (e.g. `<stack_slug>.grafana.net`).
5454
- `org_id` (Number) Organization id to assign to this stack.
5555
- `org_name` (String) Organization name to assign to this stack.
5656
- `org_slug` (String) Organization slug to assign to this stack.

docs/resources/cloud_stack.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -26,9 +26,8 @@ resource "grafana_cloud_stack" "test" {
2626

2727
### Required
2828

29-
- `name` (String) Name of stack. Conventionally matches the url of the instance (e.g. “<stack_slug>.grafana.net”).
30-
- `slug` (String) Subdomain that the Grafana instance will be available at (i.e. setting slug to “<stack_slug>” will make the instance
31-
available at “https://<stack_slug>.grafana.net".
29+
- `name` (String) Name of stack. Conventionally matches the url of the instance (e.g. `<stack_slug>.grafana.net`).
30+
- `slug` (String) Subdomain that the Grafana instance will be available at. Setting slug to `<stack_slug>` will make the instance available at `https://<stack_slug>.grafana.net`.
3231

3332
### Optional
3433

internal/resources/cloud/resource_cloud_stack.go

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@ func ResourceStack() *schema.Resource {
5252
"name": {
5353
Type: schema.TypeString,
5454
Required: true,
55-
Description: "Name of stack. Conventionally matches the url of the instance (e.g. <stack_slug>.grafana.net).",
55+
Description: "Name of stack. Conventionally matches the url of the instance (e.g. `<stack_slug>.grafana.net`).",
5656
},
5757
"description": {
5858
Type: schema.TypeString,
@@ -62,9 +62,8 @@ func ResourceStack() *schema.Resource {
6262
"slug": {
6363
Type: schema.TypeString,
6464
Required: true,
65-
Description: `
66-
Subdomain that the Grafana instance will be available at (i.e. setting slug to “<stack_slug>” will make the instance
67-
available at “https://<stack_slug>.grafana.net".`,
65+
Description: "Subdomain that the Grafana instance will be available at. " +
66+
"Setting slug to `<stack_slug>` will make the instance available at `https://<stack_slug>.grafana.net`.",
6867
ValidateFunc: validation.All(
6968
validation.StringMatch(stackSlugRegex, "must be a lowercase alphanumeric string and must start with a letter."),
7069
validation.StringLenBetween(1, 29),

0 commit comments

Comments
 (0)