[chore]docs; update admonition syntax #9409
Conversation
Following the conventions in https://grafana.com/docs/writers-toolkit/style-guide/style-conventions/#admonitions Part of ongoing chore to standardize admonitions across docs
|
|
github-actions
bot
added
the
type/docs
MattDodsonEnglish
added
area/docs
and removed
type/docs
|
@jkld11 I've tried to check how all these look in a local deploy, and I think all rendered correctly. |
| @@ -1237,8 +1237,9 @@ will be sent over the WebSocket multiple times. | |||
|
|
|||
| ### `GET /api/prom/query` | |||
|
|
|||
| > **WARNING**: `/api/prom/query` is DEPRECATED; use `/loki/api/v1/query_range` | |||
| > instead. | |||
| {{% admonition type="warning" %}} | |||
There was a problem hiding this comment.
I think your script missed one (because it's inconsistent in the docs)
Up at line 1191 there's a deprecation note that should be changed to a warning.
| stack name and service name for each swarm service and project name | ||
| and service name for each compose service are automatically discovered and | ||
| sent as Loki labels, this way you can filter by them in Grafana. | ||
| {{% /admonition %}} |
There was a problem hiding this comment.
Line 153, another note that was missed because the formatting wasn't standard.
github-actions
bot
added
the
type/docs
|
I've updated the ones you found, thanks! I'm sure that these sweeps are missing a few cases, but at least we're moving in the right direction. I'm OK to merge whenever. |
|
OK, I tried to edit the template files in From a quick Google search, I gather the fix is to add the percent character as a variable in the Makefile, and I think that's getting out of the scope for this little PR. It's not a big deal in the end; I reverted the changes with 10e0947 and 67d7c02. Footnotes |
|
Closing as stale. Replaced by #11408 |
**What this PR does / why we need it**: Updates Notes to use the Hugo admonition shortcode. **Which issue(s) this PR fixes**: Replaces PR #9409 which has gone stale.
**What this PR does / why we need it**: Completing the work that was started in #9409 but not completed because there were multiple variations on how to format notes in the docs source files. We rolled out different colors for admonitions recently, which highlighted that there were still a few notes not using the admonition shortcode. I searched the docs for the following words: * tip * caution * important * warning * note So hopefully I've caught all of the admonitions that weren't using the shortcode.
**What this PR does / why we need it**: Updates Notes to use the Hugo admonition shortcode. **Which issue(s) this PR fixes**: Replaces PR grafana#9409 which has gone stale.
**What this PR does / why we need it**: Completing the work that was started in grafana#9409 but not completed because there were multiple variations on how to format notes in the docs source files. We rolled out different colors for admonitions recently, which highlighted that there were still a few notes not using the admonition shortcode. I searched the docs for the following words: * tip * caution * important * warning * note So hopefully I've caught all of the admonitions that weren't using the shortcode.
Following the conventions in https://grafana.com/docs/writers-toolkit/style-guide/style-conventions/#admonitions
Part of ongoing chore to standardize admonitions across docs