Improve the ruleset_rule time_frame documentation
#340
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
metavida
force-pushed
the
improve-ruleset_rule-time_frame-documentation
branch
from
1a54528 to
75f4378
Compare
Specifically, the previous description of how to choose a `start_time` value was misleading & did not explain how picking a correct value also involves the specified `timezone` Also update the code example to use the `time_static` resource.
metavida
force-pushed
the
improve-ruleset_rule-time_frame-documentation
branch
from
75f4378 to
49c5f46
Compare
Co-authored-by: Tyurina <tyurina@pagerduty.com>
metavida
force-pushed
the
improve-ruleset_rule-time_frame-documentation
branch
from
187850e to
9321231
Compare
stmcallister
suggested changes
May 26, 2021
|
Ah! Good catch, @stmcallister ! I've removed those 3 cases of "interpolation-only expressions" in e3f0ec6 and tested locally to confirm that the syntax still works as expected 👍 |
stmcallister
approved these changes
May 27, 2021
|
Thanks so much for getting this merged! Will the documentation changes to live at https://registry.terraform.io/providers/PagerDuty/pagerduty/latest/docs/resources/ruleset_rule when we (i.e. you) release a new version of the terraform provider? |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Specifically, the previous description of how to choose a
start_timevalue was misleading & did not explain how picking a correct value also involves the specifiedtimezoneAlso update the code example to demonstrate how to use the
time_staticresource for slightly more human-readable configuration. Best I could tell there is not a way to use other built-in time functions likeformatdateto create a unix epoch timestamp, which is why I picked thetime_staticresource.A future improvement to the provider might include allowing users to specify
start_timeand other unix timestamp attributes using RFC 3339 "Date and Time format" syntax, but that improvement is out of the scope of this PR.