Skip to content

docs: add ReplacementTransformer reference#6196

Open
locker95 wants to merge 1 commit into
kubernetes-sigs:masterfrom
locker95:docs/5812-replacement-transformer
Open

docs: add ReplacementTransformer reference#6196
locker95 wants to merge 1 commit into
kubernetes-sigs:masterfrom
locker95:docs/5812-replacement-transformer

Conversation

@locker95

Copy link
Copy Markdown

Summary

  • Adds a reference page for the built-in ReplacementTransformer under site/content/en/docs/Reference/API/Transformers/, matching the format of other transformer docs (LabelTransformer, AnnotationsTransformer, etc.).
  • Documents the replacements field and how to invoke the transformer via the Kustomization transformers field.
  • Points readers to the existing replacements field documentation for the full schema and field behavior.

This addresses the missing entry called out in #5812 (other transformers are documented under this API reference section).

Test / Verification

  • New page path: site/content/en/docs/Reference/API/Transformers/ReplacementTransformer.md
  • Examples aligned with the built-in plugin tests in plugin/builtin/replacementtransformer/
  • relref targets match existing Transformers index and Kustomization replacements docs
  • Docs-only change; git diff --check clean

Fixes #5812

/kind documentation

Add a reference page for the built-in ReplacementTransformer under
API Transformers, matching the style of other transformer docs and
pointing to the existing replacements field documentation.

Fixes kubernetes-sigs#5812

Signed-off-by: Dean Chen <862469039@qq.com>
@kubernetes-prow kubernetes-prow Bot added do-not-merge/invalid-commit-message Indicates that a PR should not merge because it has an invalid commit message. kind/documentation Categorizes issue or PR as related to documentation. labels Jul 22, 2026
@kubernetes-prow

Copy link
Copy Markdown
Contributor

Invalid commit message issues detected

Invalid commit messages

Keywords which can automatically close issues and hashtag(#) mentions are not allowed.

  • a3a6bf9 docs: add ReplacementTransformer reference

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository. I understand the commands that are listed here.

@kubernetes-prow
kubernetes-prow Bot requested a review from koba1t July 22, 2026 19:16
@kubernetes-prow

Copy link
Copy Markdown
Contributor

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by: locker95
Once this PR has been reviewed and has the lgtm label, please assign varshaprasad96 for approval. For more information see the Code Review Process.

The full list of commands accepted by this bot can be found here.

Details Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@kubernetes-prow
kubernetes-prow Bot requested a review from sarab97 July 22, 2026 19:16
@kubernetes-prow kubernetes-prow Bot added the cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. label Jul 22, 2026
@kubernetes-prow

Copy link
Copy Markdown
Contributor

Welcome @locker95!

It looks like this is your first PR to kubernetes-sigs/kustomize 🎉. Please refer to our pull request process documentation to help your PR have a smooth ride to approval.

You will be prompted by a bot to use commands during the review process. Do not be afraid to follow the prompts! It is okay to experiment. Here is the bot commands documentation.

You can also check if kubernetes-sigs/kustomize has its own contribution guidelines.

You may want to refer to our testing guide if you run into trouble with your tests not passing.

If you are having difficulty getting your pull request seen, please follow the recommended escalation practices. Also, for tips and tricks in the contribution process you may want to read the Kubernetes contributor cheat sheet. We want to make sure your contribution gets all the attention it needs!

Thank you, and welcome to Kubernetes. 😃

@kubernetes-prow

Copy link
Copy Markdown
Contributor

Hi @locker95. Thanks for your PR.

I'm waiting for a kubernetes-sigs member to verify that this patch is reasonable to test. If it is, they should reply with /ok-to-test on its own line. Until that is done, I will not automatically test new commits in this PR, but the usual testing commands by org members will still work.

Regular contributors should join the org to skip this step.

Once the patch is verified, the new status will be reflected by the ok-to-test label.

I understand the commands that are listed here.

Details

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository.

@kubernetes-prow kubernetes-prow Bot added needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. size/M Denotes a PR that changes 30-99 lines, ignoring generated files. labels Jul 22, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. do-not-merge/invalid-commit-message Indicates that a PR should not merge because it has an invalid commit message. kind/documentation Categorizes issue or PR as related to documentation. needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. size/M Denotes a PR that changes 30-99 lines, ignoring generated files.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

No docs for ReplacementTransformer

1 participant