chore(docs): standardize use of notes #538
Conversation
| @@ -2,7 +2,7 @@ | |||
|
|
|||
| The `honeycombio_column` data source retrieves the details of a single column in a dataset. | |||
|
|
|||
| -> **Note** Terraform will fail unless a column is returned by the search. Ensure that your search is specific enough to return a column. | |||
| ~> **Warning** Terraform will fail unless a column is returned by the search. Ensure that your search is specific enough to return a column. | |||
There was a problem hiding this comment.
I think I'm still a lil confused what this will end up looking like based on this table.
Will this end up as a yellow callout with the text prefix **Note** **Warning**, since it's using ~>?
I also notice that it says !> is supposed to end up with a red callout and the **Warning** prefix, but for all of our callouts that say "Warning" we're using ~> -- is that what we want? (my guess is yes since they seem like less important warnings, but wanted to check)
There was a problem hiding this comment.
Providing a **Something** overrides the default text prefix, so the above renders like this:
I should have linked their Doc Preview Tool which lets you try out their flavor of Markdown
There was a problem hiding this comment.
Got it, thanks! I'll bookmark that for later, I did not realize it was an override but that sounds perfect.
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #538 +/- ##
=======================================
Coverage 79.23% 79.23%
=======================================
Files 75 75
Lines 5963 5963
=======================================
Hits 4725 4725
Misses 915 915
Partials 323 323 ☔ View full report in Codecov by Sentry. |
Noticed while browsing the provider docs that the use of "callouts" (largely used for notes) is a bit inconsistent.
This change attempts to fix that, while using the available yellow and red callouts for warnings and deprecation notices.