Repository navigation
docs: use alert shortcode for remaining Note callouts - #4838
Merged
Catalin-Stratulat-Ericsson merged 1 commit intoOct 29, 2026
Merged
Catalin-Stratulat-Ericsson merged 1 commit into
Catalin-Stratulat-Ericsson merged 1 commit into
Conversation
Convert the four remaining plain-text "Note:" callouts in the guides to
the Docsy {{% alert %}} shortcode so they render as highlighted notes,
matching the convention already used elsewhere in the docs.
Files updated:
- guides/3-way-merge.md
- guides/krm-functions/containerizing.md (file-mode and published-image notes)
- guides/krm-functions/testing.md
Fixes kptdev#4533
Assisted-by: Kiro
Signed-off-by: Aravindhan Ayyanathan <aravindhan.a@est.tech>
aravindtga
requested review from
efiacor,
kispaljr,
liamfallon and
mozesl-nokia
as code owners
October 28, 2026 16:22
✅ Deploy Preview for kptdocs ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
Contributor
There was a problem hiding this comment.
🟢 Approval recommended
There are no active review issues with the documentation callout standardization.
No open issues 🎉
What changed in this PR
Standardizes four guide notes using Docsy alert shortcodes so they appear as highlighted callouts, consistent with the documentation convention and issue #4533.
Changes:
- Replaces plain-text and blockquote notes with
alertshortcodes. - Uses
title="Note"for the label and removes redundant “Note:” prefixes.
| File | Description |
|---|---|
| documentation/content/en/guides/krm-functions/testing.md | Converts the golden-test environment variable note to an alert. |
| documentation/content/en/guides/krm-functions/containerizing.md | Converts file-mode and container-image notes to alerts. |
| documentation/content/en/guides/3-way-merge.md | Converts the merge-strategy blockquote note to an alert. |
Review effort: Balanced
mozesl-nokia
approved these changes
Oct 29, 2026
Catalin-Stratulat-Ericsson
approved these changes
Oct 29, 2026
Catalin-Stratulat-Ericsson
left a comment
Catalin-Stratulat-Ericsson
left a comment
Contributor
There was a problem hiding this comment.
good stuff
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
{{% alert title="Note" color="primary" %}}shortcode.Note:/> Note:block is replaced with the Docsyalertshortcode, withtitle="Note"supplying the label so the leading "Note:" text is removed from the body.Related Issue(s)
Type of Change
Checklist
AI Disclosure
If so, please describe how:
- Kiro (Assisted-by tag in the commit) to convert the callouts to the alert shortcode and to draft this PR description.