doc(kustomize/replacements): add select and reject explanation

[bugoverdose]

from kubernetes-sigs/kustomize#5263

After fixing a bug regarding the replacements field at kustomize, I'm adding an explanation on the current functionality with a basic example.

cc. @natasha41575

[k8s-ci-robot]

Welcome @bugoverdose!

It looks like this is your first PR to kubernetes-sigs/cli-experimental 🎉. 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/cli-experimental 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. 😃

[natasha41575]

/hold

Adding a hold as we will wait for the next release to merge this

[natasha41575]

Thanks! Looks good. Small comment to request that we add similar documentation for the select field.

I know you didn't change select, but it will be helpful to document that behavior too.

[natasha41575]

Above, somewhere it says:

Replacements will be applied to all targets that are matched by the `select` field and
are NOT matched by the `reject` field, and will be applied to all listed `fieldPaths`.

Could you add another example, after this sentence, similar to the one you added here for reject, but with a ####Select header, to show that you can also use select with a previous or current id?

[bugoverdose]

68a0cef

1. It felt kinda random to explain only about the behavior I fixed, so I added a bit more info about the functionality of select field in general so that it matches reject.
2. I used namePrefix for explaining select because I already used nameSuffix at reject.

[natasha41575]

/lgtm
/approve

LGTM! The docs go live as soon as the PR is merged, so we can remove the hold during the next kustomize release. Thanks so much for the change

[k8s-ci-robot]

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: bugoverdose, natasha41575

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

The pull request process is described here

Needs approval from an approver in each of these files:

• OWNERS [natasha41575]

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

[bugoverdose]

@natasha41575 This PR is not merged yet, but I'm thinking about applying the changes to our new doc. Below is the PR I'm working on right now.

• Add API section to Reference Section kustomize#5313

[natasha41575]

This PR is not merged yet, but I'm thinking about applying the changes to our new doc. Below is the PR I'm working on right now.

SGTM. We will almost certainly release your fixes before the new docs site is launched, so feel free to add the changes there.

[k8s-triage-robot]

The Kubernetes project currently lacks enough contributors to adequately respond to all PRs.

This bot triages PRs according to the following rules:

• After 90d of inactivity, lifecycle/stale is applied
• After 30d of inactivity since lifecycle/stale was applied, lifecycle/rotten is applied
• After 30d of inactivity since lifecycle/rotten was applied, the PR is closed

You can:

• Mark this PR as fresh with /remove-lifecycle stale
• Close this PR with /close
• Offer to help out with Issue Triage

Please send feedback to sig-contributor-experience at kubernetes/community.

/lifecycle stale

[k8s-triage-robot]

The Kubernetes project currently lacks enough active contributors to adequately respond to all PRs.

This bot triages PRs according to the following rules:

• After 90d of inactivity, lifecycle/stale is applied
• After 30d of inactivity since lifecycle/stale was applied, lifecycle/rotten is applied
• After 30d of inactivity since lifecycle/rotten was applied, the PR is closed

You can:

• Mark this PR as fresh with /remove-lifecycle rotten
• Close this PR with /close
• Offer to help out with Issue Triage

Please send feedback to sig-contributor-experience at kubernetes/community.

/lifecycle rotten

[k8s-triage-robot]

The Kubernetes project currently lacks enough active contributors to adequately respond to all issues and PRs.

This bot triages PRs according to the following rules:

• After 90d of inactivity, lifecycle/stale is applied
• After 30d of inactivity since lifecycle/stale was applied, lifecycle/rotten is applied
• After 30d of inactivity since lifecycle/rotten was applied, the PR is closed

You can:

• Reopen this PR with /reopen
• Mark this PR as fresh with /remove-lifecycle rotten
• Offer to help out with Issue Triage

Please send feedback to sig-contributor-experience at kubernetes/community.

/close

[k8s-ci-robot]

@k8s-triage-robot: Closed this PR.

In response to this:

The Kubernetes project currently lacks enough active contributors to adequately respond to all issues and PRs.

This bot triages PRs according to the following rules:

• After 90d of inactivity, lifecycle/stale is applied
• After 30d of inactivity since lifecycle/stale was applied, lifecycle/rotten is applied
• After 30d of inactivity since lifecycle/rotten was applied, the PR is closed

You can:

• Reopen this PR with /reopen
• Mark this PR as fresh with /remove-lifecycle rotten
• Offer to help out with Issue Triage

Please send feedback to sig-contributor-experience at kubernetes/community.

/close

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/test-infra repository.