Skip to content

Conversation

@maximusmith529
Copy link
Contributor

@maximusmith529 maximusmith529 commented Oct 21, 2025

Proposed changes

Callouts with headers (important, caution, warning, and deprecated) and no custom title were incorrectly rendering inside of tab groups. This fix prevents that by checking if there is a title, if not it uses the typing of the call-out.

In addition I've removed the deprecated examples within the site, so only up-to-date examples are on it.

I've included the before and after for callouts within tab groups and outside of. There has been noticeable change to regular, non-tabbed, loud callouts.

Before After
image image
image image

This is in response to this issue: nginx/documentation#1163

Thanks @JTorreG for the clarification on the issue and your workaround!

Checklist

Before creating a PR, run through this checklist and mark each as complete.

@maximusmith529 maximusmith529 changed the title chore: Add error for deprecated call-out shortcodes Add errors for deprecated callouts Oct 21, 2025
Copy link
Collaborator

@lamATnginx lamATnginx left a comment

Choose a reason for hiding this comment

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

Can you clean up the exampleSite based on the pipleine? We don't want to encourage these shortcodes from being used.

@maximusmith529
Copy link
Contributor Author

I'll check it out 🫡

@maximusmith529 maximusmith529 force-pushed the callout-deprecation-error branch from 7a2b2d2 to 24b65da Compare October 22, 2025 19:57
@github-actions
Copy link

Deploy Preview will be available once build job completes!

Name Link
😎 Deploy Preview https://frontdoor-test-docs.nginx.com/previews/nginx-hugo-theme/430/

@maximusmith529 maximusmith529 changed the title Add errors for deprecated callouts Fix callouts with headers in tab groups not rendering Oct 22, 2025
@maximusmith529 maximusmith529 force-pushed the callout-deprecation-error branch from 07a3918 to f40778c Compare October 22, 2025 22:51
@maximusmith529 maximusmith529 marked this pull request as ready for review October 22, 2025 22:51
@maximusmith529 maximusmith529 requested a review from a team as a code owner October 22, 2025 22:51
Copy link
Collaborator

@lamATnginx lamATnginx left a comment

Choose a reason for hiding this comment

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

Remove the old "plain" shortcodes. Not needed.

Copy link
Collaborator

@lamATnginx lamATnginx left a comment

Choose a reason for hiding this comment

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

Remove old "plain" callouts usages in other files such as test-product/everything.md.

Do not outright remove everything. We still want to preserve the original intent of whatever was using the old "plain" shortcodes, so in some cases, a rewrite is needed. For example, in test-product/call-out/call-out-code-lists.md, we need to rewrite the two note shortcodes.

@lamATnginx lamATnginx requested a review from a team October 23, 2025 11:53
@lamATnginx lamATnginx added the bug Something isn't working label Oct 23, 2025
@maximusmith529 maximusmith529 force-pushed the callout-deprecation-error branch from f40778c to f6faf8d Compare October 23, 2025 20:28
Copy link
Collaborator

@lamATnginx lamATnginx left a comment

Choose a reason for hiding this comment

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

Remove old shortcodes.

Besides that, LGTM.

@maximusmith529 maximusmith529 force-pushed the callout-deprecation-error branch from f6faf8d to 49777a0 Compare October 24, 2025 16:03
@maximusmith529 maximusmith529 force-pushed the callout-deprecation-error branch from 49777a0 to d77a6a7 Compare October 27, 2025 21:47
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

bug Something isn't working

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants