From 7b60868119d9e19e189e88e04a02957cf9ac5e62 Mon Sep 17 00:00:00 2001 From: Aravindhan Ayyanathan Date: Wed, 28 Oct 2026 15:02:16 +0000 Subject: [PATCH] docs: use alert shortcode for remaining Note callouts 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 #4533 Assisted-by: Kiro Signed-off-by: Aravindhan Ayyanathan --- documentation/content/en/guides/3-way-merge.md | 8 +++++--- .../content/en/guides/krm-functions/containerizing.md | 8 ++++++-- documentation/content/en/guides/krm-functions/testing.md | 4 +++- 3 files changed, 14 insertions(+), 6 deletions(-) diff --git a/documentation/content/en/guides/3-way-merge.md b/documentation/content/en/guides/3-way-merge.md index d199512085..15575eb703 100644 --- a/documentation/content/en/guides/3-way-merge.md +++ b/documentation/content/en/guides/3-way-merge.md @@ -293,9 +293,11 @@ you need to retain a local value that upstream also changed, choose one of these - Use `--strategy force-delete-replace` to reset to upstream, then re-apply customizations deliberately -> Note: the other strategies behave differently on the same clash — `copy-merge` -> and `force-delete-replace` also take the upstream value (at the file level), -> while `fast-forward` refuses to run at all if the local package was modified. +{{% alert title="Note" color="primary" %}} +The other strategies behave differently on the same clash - `copy-merge` +and `force-delete-replace` also take the upstream value (at the file level), +while `fast-forward` refuses to run at all if the local package was modified. +{{% /alert %}} ### Tips for Avoiding Conflicts diff --git a/documentation/content/en/guides/krm-functions/containerizing.md b/documentation/content/en/guides/krm-functions/containerizing.md index fb509d528c..4bebf5a5d3 100644 --- a/documentation/content/en/guides/krm-functions/containerizing.md +++ b/documentation/content/en/guides/krm-functions/containerizing.md @@ -92,9 +92,11 @@ docker run --rm -i ghcr.io/kptdev/krm-functions-catalog/my-function:v0.1 < input docker run --rm -v $(pwd):/data ghcr.io/kptdev/krm-functions-catalog/my-function:v0.1 /data/deployment.yaml ``` -Note: file mode assembles the given files into a ResourceList with an **empty +{{% alert title="Note" color="primary" %}} +File mode assembles the given files into a ResourceList with an **empty functionConfig**. Functions that require configuration should be run via STDIN (or a `kpt` pipeline) so the functionConfig is provided. +{{% /alert %}} ### Help and doc flags @@ -124,9 +126,11 @@ pipeline: namespace: production ``` -Note: the image must be published and accessible from the machine running +{{% alert title="Note" color="primary" %}} +The image must be published and accessible from the machine running `kpt fn render`. For local development, build the image locally first. It will be used from the local Docker cache without pulling. +{{% /alert %}} ## Tips diff --git a/documentation/content/en/guides/krm-functions/testing.md b/documentation/content/en/guides/krm-functions/testing.md index c754fa7287..08f3ad3d4d 100644 --- a/documentation/content/en/guides/krm-functions/testing.md +++ b/documentation/content/en/guides/krm-functions/testing.md @@ -153,9 +153,11 @@ output. Golden tests verify *stability* (did the output change?), not For correctness guarantees, complement golden tests with property-based tests that assert invariants (e.g., "all resources have the expected label"). -Note: other kpt ecosystem projects use different env var names for the same +{{% alert title="Note" color="primary" %}} +Other kpt ecosystem projects use different env var names for the same purpose (`KPT_E2E_UPDATE_EXPECTED` in kpt, `UPDATE_GOLDEN_FILES` in porch). `WRITE_GOLDEN_OUTPUT` is the standard for the SDK and catalog functions. +{{% /alert %}} ## Testing a ResourceListProcessor