loft-sh / vcluster

vCluster - Create fully functional virtual Kubernetes clusters - Each vcluster runs inside a namespace of the underlying k8s cluster. It's cheaper than creating separate full-blown clusters and it offers better multi-tenancy and isolation than regular namespaces.
https://www.vcluster.com
Apache License 2.0
6.92k stars 426 forks source link

chore: Update translate to patches #2198

Closed ThomasK33 closed 1 month ago

ThomasK33 commented 1 month ago

What issue type does this pull request address? (keep at least one, remove the others) /kind enhancement

What does this pull request do? Which issues does it resolve? (use resolves #<issue_number> if possible) resolves ENG-4775

Please provide a short message that should be published in the vcluster release notes Renamed translate field to patches

What else do we need to know?

netlify[bot] commented 1 month ago

Deploy Preview for vcluster-docs canceled.

Name Link
Latest commit b0cf306ea452f7e26d6e7a3633c73e26309c6763
Latest deploy log https://app.netlify.com/sites/vcluster-docs/deploys/6703a1aed0c75d0008a0e7ca
ThomasK33 commented 1 month ago

Patch can both be a noun and a verb but I don't think it should be both in a single sentence. I would prefer a description such as "Defines patches to be applied to resources." or "Defines patches for resources", as patches are usually used for one thing- patching.

How does that align with Go doc conventions?

An example from the Go std lib: https://pkg.go.dev/io#Copy