Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Support the use of GitHub markdown alerts for the specs #5557

Open
chalin opened this issue Nov 8, 2024 · 2 comments
Open

Support the use of GitHub markdown alerts for the specs #5557

chalin opened this issue Nov 8, 2024 · 2 comments
Labels
enhancement New feature or request p3-low sig:spec

Comments

@chalin
Copy link
Contributor

chalin commented Nov 8, 2024

GitHub markdown alerts are now being used in the OTel spec. I would be a nice to have to support their proper formatting (which I thought that Hugo already did -- I'll have to investigate, it might require a bit of extra coding).

For example, see https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/logs/sdk.md#logs-api.

https://github.com/open-telemetry/opentelemetry-specification/blob/8bc96330a1c17ff5194c5afcf7d32b9ee24b65e3/specification/logs/sdk.md?plain=1#L542-L545:

## Logs API


> [!NOTE]
> We are currently in the process of defining a new [Logs API](./api.md#logs-api).

This currently renders as follows for the OTel website:

image

On GitHub, it looks like this (we don't have to match the look exactly):

image

We might want to consider wrapping that into an {{% alert %}}?

@svrnm
Copy link
Member

svrnm commented Nov 8, 2024

When you say wrapping that into the alert shortcode do you mean we write some transformation code that turns

> [!NOTE]
> We are currently in the process of defining a new [Logs API](./api.md#logs-api).

into

{{% alert title="Note" color="info" %}}
We are currently in the process of defining a new [Logs API](./api.md#logs-api).
{{% /alert %}}

?

@chalin
Copy link
Contributor Author

chalin commented Nov 8, 2024

Yes. The idea is that Hugo would be doing that automatically for us using a block-quote hook.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request p3-low sig:spec
Projects
Status: No status
Development

No branches or pull requests

2 participants