Skip to content

docs: use alert shortcode for remaining Note callouts #4838

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.

Sign up for GitHub

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

Merged
Catalin-Stratulat-Ericsson merged 1 commit into from
Oct 29, 2026
Merged

docs: use alert shortcode for remaining Note callouts #4838

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 5 additions & 3 deletions documentation/content/en/guides/3-way-merge.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
8 changes: 6 additions & 2 deletions documentation/content/en/guides/krm-functions/containerizing.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down Expand Up @@ -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

Expand Down
4 changes: 3 additions & 1 deletion documentation/content/en/guides/krm-functions/testing.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
Loading