Skip to content

Commit 5833442

Browse files
authored
Escape k6 schedule values in docs (#2395)
1 parent 67768b3 commit 5833442

File tree

4 files changed

+8
-8
lines changed

4 files changed

+8
-8
lines changed

docs/data-sources/k6_schedule.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -90,8 +90,8 @@ output "complete_schedule_info" {
9090

9191
Read-Only:
9292

93-
- `schedule` (String) A cron expression with exactly 5 entries, or an alias. The allowed aliases are: @yearly, @annually, @monthly, @weekly, @daily, @hourly.
94-
- `timezone` (String) The timezone of the cron expression. For example, 'UTC' or 'Europe/London'.
93+
- `schedule` (String) A cron expression with exactly 5 entries, or an alias. The allowed aliases are: `@yearly`, `@annually`, `@monthly`, `@weekly`, `@daily`, `@hourly`.
94+
- `timezone` (String) The timezone of the cron expression. For example, `UTC` or `Europe/London`.
9595

9696

9797
<a id="nestedblock--recurrence_rule"></a>

docs/resources/k6_schedule.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -104,8 +104,8 @@ resource "grafana_k6_schedule" "one_time" {
104104

105105
Optional:
106106

107-
- `schedule` (String) A cron expression with exactly 5 entries, or an alias. The allowed aliases are: @yearly, @annually, @monthly, @weekly, @daily, @hourly.
108-
- `timezone` (String) The timezone of the cron expression. For example, 'UTC' or 'Europe/London'.
107+
- `schedule` (String) A cron expression with exactly 5 entries, or an alias. The allowed aliases are: `@yearly`, `@annually`, `@monthly`, `@weekly`, `@daily`, `@hourly`.
108+
- `timezone` (String) The timezone of the cron expression. For example, `UTC` or `Europe/London`.
109109

110110

111111
<a id="nestedblock--recurrence_rule"></a>

internal/resources/k6/data_source_k6_schedule.go

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -113,11 +113,11 @@ func (d *scheduleDataSource) Schema(_ context.Context, _ datasource.SchemaReques
113113
Description: "The cron schedule to trigger the test periodically. If null, the test will run only once on the 'starts' date.",
114114
Attributes: map[string]schema.Attribute{
115115
"schedule": schema.StringAttribute{
116-
Description: "A cron expression with exactly 5 entries, or an alias. The allowed aliases are: @yearly, @annually, @monthly, @weekly, @daily, @hourly.",
116+
Description: "A cron expression with exactly 5 entries, or an alias. The allowed aliases are: `@yearly`, `@annually`, `@monthly`, `@weekly`, `@daily`, `@hourly`.",
117117
Computed: true,
118118
},
119119
"timezone": schema.StringAttribute{
120-
Description: "The timezone of the cron expression. For example, 'UTC' or 'Europe/London'.",
120+
Description: "The timezone of the cron expression. For example, `UTC` or `Europe/London`.",
121121
Computed: true,
122122
},
123123
},

internal/resources/k6/resource_schedule.go

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -161,11 +161,11 @@ func (r *scheduleResource) Schema(_ context.Context, _ resource.SchemaRequest, r
161161
Description: "The cron schedule to trigger the test periodically. If not specified, the test will run only once on the 'starts' date. Only one of `recurrence_rule` and `cron` can be set.",
162162
Attributes: map[string]schema.Attribute{
163163
"schedule": schema.StringAttribute{
164-
Description: "A cron expression with exactly 5 entries, or an alias. The allowed aliases are: @yearly, @annually, @monthly, @weekly, @daily, @hourly.",
164+
Description: "A cron expression with exactly 5 entries, or an alias. The allowed aliases are: `@yearly`, `@annually`, `@monthly`, `@weekly`, `@daily`, `@hourly`.",
165165
Optional: true,
166166
},
167167
"timezone": schema.StringAttribute{
168-
Description: "The timezone of the cron expression. For example, 'UTC' or 'Europe/London'.",
168+
Description: "The timezone of the cron expression. For example, `UTC` or `Europe/London`.",
169169
Optional: true,
170170
},
171171
},

0 commit comments

Comments
 (0)