[Discuss] Inline admonitions

[bmorelli25]

Summary

You can find an example of an inline admonition in this page:

Data set quality | Elastic Observability [8.17] | Elastic

The text [beta] on top of the page is an inline admonition. If you have over it, you will see a tooltip-style box. There is no equivalent functionality in MyST, so for now we are converting it an admonition of type ‘important'.

```{admonition} <title>
:class: important
<text>
```

To do

• Add support for context-specific admonitions #94 and Add support for page-level metadata #95 will add support for beta/preview callouts to V3
• After these hit, determine a new mapping from asciidoc to v3 for inline admonitions
• Determine which inline admonitions exist outside of the context of versioning and also need to be added

[Mpdreamz]

I don't think we should support this for reasons mentioned here: #94 (comment)

[bmorelli25]

This decision to be validated during migration. Added as an open question to #160.

[bmorelli25]

From @siamakp-elastic in regards to inline admonitions in code callouts:

Look at this page:
https://www.elastic.co/guide/en/observability/current/apm-open-telemetry-direct.html
The callout #8 has an inline admonition preview. I used to render them ('beta', 'preview', etc) as block admonitions. But admonition won't work in the callout case above. I've changed it to be just the title in the brackets: [preview].
That means that the documents that have an inline beta inline admonition, will just show [beta] without any more information. Note that the Asciidoc inline admonition acts like a hover tooltip.

[charlotte-hoblik]

I came across a couple of inline admonitions inside table cells, as shown in the screenshot. It is tricky to replace them using callouts or prose when only a few rows are marked in the table.