From 1d75ac4416abb8b98e81c8a02e9aa8e7f7527c8f Mon Sep 17 00:00:00 2001 From: Jack Baldry Date: Thu, 1 Feb 2024 20:55:46 +0000 Subject: [PATCH] Fix rendering of example admonitions Signed-off-by: Jack Baldry --- .../deprecate-remove/{_index.md => index.md} | 30 +++++++++++-------- 1 file changed, 17 insertions(+), 13 deletions(-) rename docs/sources/write/deprecate-remove/{_index.md => index.md} (88%) diff --git a/docs/sources/write/deprecate-remove/_index.md b/docs/sources/write/deprecate-remove/index.md similarity index 88% rename from docs/sources/write/deprecate-remove/_index.md rename to docs/sources/write/deprecate-remove/index.md index a236590ee..190c3a79a 100644 --- a/docs/sources/write/deprecate-remove/_index.md +++ b/docs/sources/write/deprecate-remove/index.md @@ -40,11 +40,11 @@ Scenario: "You're planning on removing the feature or product in a future releas Example text: -``` -{{% admonition type="caution" %}} +```markdown +{{}} Starting with , is deprecated. It will be removed in a future release. -{{% /admonition %}} +{{}} ``` If you know the release, enter the release instead of "future". @@ -55,11 +55,11 @@ Scenario: "You've removed a feature." Example text: -``` -{{% admonition type="warning" %}} +```markdown +{{}} is removed. It is no longer deployed, enhanced, or supported. -{{% /admonition %}} +{{}} ``` ## Documentation deprecation @@ -68,17 +68,21 @@ Scenario: There are situations in which you may deprecate documentation along wi Example text: -``` -{{% admonition type="caution" %}} - Starting with release `, the documentation will no longer be published because . + + + +```markdown +{{}} +Starting with release `, the documentation will no longer be published because . Link to documentation, if it exists. -{{% /admonition %}} +{{}} ``` - - +Concrete example: -Example: "As of Grafana 9.2, release notes will no longer be published, because they duplicate the content available in the What’s New document and the CHANGELOG." +{{< admonition type="caution" >}} +As of Grafana 9.2, release notes will no longer be published, because they duplicate the content available in the What’s New document and the CHANGELOG." +{{< /admonition >}}