Skip to content

Conversation

@harikapadia999
Copy link

Description

This PR adds guidance to the contributing style guide explaining when to use the GFM alert blockquote Markdown syntax versus the Hugo alert shortcode.

Changes

  • Added new "Alert syntax" section under the Markdown section
  • Recommends GFM alert blockquote syntax as the default choice for better portability and readability
  • Explains when to use the Hugo shortcode (for advanced features like custom titles)
  • Includes examples for both approaches

Related Issue

Fixes #8485

Checklist

  • Added clear guidance on alert syntax preference
  • Included examples for both GFM and shortcode syntax
  • Explained when to favor each approach
  • Followed existing style guide formatting

Add section explaining when to use GFM alert blockquote syntax vs Hugo alert shortcode, encouraging the use of Markdown syntax for most cases while noting shortcode availability for advanced features.

Fixes open-telemetry#8485
@linux-foundation-easycla
Copy link

linux-foundation-easycla bot commented Dec 6, 2025

CLA Signed
The committers listed above are authorized under a signed CLA.

  • ✅ login: harikapadia999 / name: HARI KAPADIA (223d043)

@otelbot-docs otelbot-docs bot requested a review from a team December 6, 2025 10:01
Copy link
Member

@theletterf theletterf left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@open-telemetry/docs-maintainers This might be a good time to decide on the syntax we want. AFAIK, we prefer the Hugo shortcode.

@svrnm
Copy link
Member

svrnm commented Dec 10, 2025

@open-telemetry/docs-maintainers This might be a good time to decide on the syntax we want. AFAIK, we prefer the Hugo shortcode.

See the issue for that discussion #8485, my understanding was that with the recently added support for github formatted alerts we want to prefer them over the shortcodes

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Status: No status

Development

Successfully merging this pull request may close these issues.

Mention new alert blockquote Markdown syntax in contrib pages and explain when to favor it over shorcode

3 participants