Skip to content

Commit

Permalink
Fix rendering of example admonitions
Browse files Browse the repository at this point in the history
Signed-off-by: Jack Baldry <[email protected]>
  • Loading branch information
jdbaldry committed Feb 1, 2024
1 parent ebeafd8 commit 1d75ac4
Showing 1 changed file with 17 additions and 13 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -40,11 +40,11 @@ Scenario: "You're planning on removing the feature or product in a future releas

Example text:

```
{{% admonition type="caution" %}}
```markdown
{{</* admonition type="caution" */>}}
Starting with <RELEASE>, <PRODUCT OR FEATURE NAME> is deprecated.
It will be removed in a future release.
{{% /admonition %}}
{{</* /admonition */>}}
```

If you know the release, enter the release instead of "future".
Expand All @@ -55,11 +55,11 @@ Scenario: "You've removed a feature."

Example text:

```
{{% admonition type="warning" %}}
```markdown
{{</* admonition type="warning" */>}}
<PRODUCT OR FEATURE NAME> is removed.
It is no longer deployed, enhanced, or supported.
{{% /admonition %}}
{{</* /admonition */>}}
```

## Documentation deprecation
Expand All @@ -68,17 +68,21 @@ Scenario: There are situations in which you may deprecate documentation along wi

Example text:

```
{{% admonition type="caution" %}}
Starting with release <VERSION>`, the <TOPIC TITLE> documentation will no longer be published because <RATIONALE>.
<!-- vale Google.Will = NO -->
<!-- vale Google.Passive = NO -->

```markdown
{{</* admonition type="caution" */>}}
Starting with release <VERSION>`, the <TOPIC TITLE> documentation will no longer be published because <RATIONALE>.
Link to documentation, if it exists.
{{% /admonition %}}
{{</* /admonition */>}}
```

<!-- vale Google.Will = NO -->
<!-- vale Google.Passive = NO -->
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 >}}

<!-- vale Google.Passive = YES -->
<!-- vale Google.Will = YES -->
Expand Down

0 comments on commit 1d75ac4

Please sign in to comment.