Improve framework documentation

[colinodell]

This PR makes several minor improvements to the documentation on https://pkg.go.dev/sigs.k8s.io/kustomize/kyaml/fn/framework:

• Fixes undefined variable in example code
• Adds import statements to help new users get up-and-running quicker
• Fixes the two commands needed to run the functions

[linux-foundation-easycla]

The committers listed above are authorized under a signed CLA.

• ✅ login: colinodell / name: Colin O'Dell (cc410bc, e25f99e, facabde, 2252fd9, 6088692, 9d66eb1)

[k8s-ci-robot]

Welcome @colinodell!

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. 😃

[k8s-ci-robot]

Hi @colinodell. 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.

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.

[stormqueen1990]

Hi there, @colinodell!

This looks like it's in the trivial edits realm as it is right now: https://www.kubernetes.dev/docs/guide/pull-requests/#trivial-edits. Could you please take a look if there are other improvements that could be made to the same file?

Could you also please sign the CLA? We won't be able to accept your contribution until you do so. More information: https://github.com/kubernetes/community/blob/master/CLA.md

[k8s-ci-robot]

This PR has multiple commits, and the default merge method is: merge.
You can request commits to be squashed using the label: tide/merge-method-squash

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.

[colinodell]

@stormqueen1990 Thanks for pointing me to those docs! I've taken this opportunity to make some other improvements to these docs, and have updated the PR title and body accordingly. I have also signed the CLA. I believe this is now ready for review, and I welcome any feedback you or others may have :)

[stormqueen1990]

Hi there, @colinodell! 👋

This is looking good. There's just one detail that might be worth updating: in the Example function block, there's a container key missing. It currently reads:

config.kubernetes.io/function: |
  image: image/containing/function:impl

whereas the format that works with kustomize fn is as follows:

config.kubernetes.io/function: |
  container:
    image: image/containing/function:impl

Other than that, LGTM. I'll leave my /lgtm for now, but if you decide to make the change please feel free to ping me for a new review.

[stormqueen1990]

/lgtm

[stormqueen1990]

Hi there, @colinodell!

It seems there is a lint failure, could you please address that?
You can run the lint check locally with make lint.

[colinodell]

This is looking good. There's just one detail that might be worth updating: in the Example function block, there's a container key missing

I've added this in cc410bc.

It seems there is a lint failure, could you please address that?
You can run the lint check locally with make lint.

Whoops! I've fixed that in 2252fd9.

(I appreciate the make lint tip too! Unfortunately, it kept failing on some unrelated depguard violations in /cmd/config, but I figured out how to run the linter on just this one file, and it seems to be passing locally now.)

[stormqueen1990]

/lgtm
/ok-to-test

[koba1t]

Hi @colinodell
Thanks for your contribution!

/approve

[k8s-ci-robot]

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: colinodell, koba1t

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 [koba1t]

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