Skip to content
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.

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

Update composition-functions.md #774

Merged
merged 1 commit into from
May 29, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
12 changes: 7 additions & 5 deletions content/master/concepts/composition-functions.md
Original file line number Diff line number Diff line change
Expand Up @@ -249,7 +249,7 @@ spec:

{{<expand "The xr.yaml, composition.yaml and function.yaml files used in the example">}}

You can recreate the output below using by running `crossplane beta render` with
You can recreate the output below by running `crossplane beta render` with
these files.

The `xr.yaml` file contains the composite resource to render:
Expand Down Expand Up @@ -309,7 +309,7 @@ spec:
{{</expand>}}

The Crossplane CLI uses Docker Engine to run functions. You can change how the
Crossplane CLI run a function by adding an annotation in `functions.yaml`. Add
Crossplane CLI runs a function by adding an annotation in `functions.yaml`. Add
the `render.crossplane.io/runtime` annotation to a Function to change how it's
run.

Expand Down Expand Up @@ -379,8 +379,10 @@ func (f *Function) RunFunction(_ context.Context, req *fnv1beta1.RunFunctionRequ
}
```

Some people design composition functions for you to use them with any kind of
<!-- vale write-good.Passive = NO -->
Some composition functions are designed to be used with any kind of
composite resource.
<!-- vale write-good.Passive = YES -->
[Function Patch and Transform](https://github.com/crossplane-contrib/function-patch-and-transform)
and
[Function Auto Ready](https://github.com/crossplane-contrib/function-auto-ready)
Expand Down Expand Up @@ -550,7 +552,7 @@ spec:
```

If any composed resources already exist, Crossplane observes them and sends them
to your function to as part of the observed state.
to your function as part of the observed state.

Crossplane also observes the connection details of your composite resource and
any composed resources. It sends them to your function as part of the observed
Expand Down Expand Up @@ -740,4 +742,4 @@ looking for a log line:

If you don't see the log line emitted when Crossplane starts, you have disabled
__extra resources__ for composition functions, which means requests by functions for __extra
resources__ are just ignored.
resources__ are just ignored.
4 changes: 2 additions & 2 deletions utils/vale/.vale.ini
Original file line number Diff line number Diff line change
Expand Up @@ -37,14 +37,14 @@ Google.OxfordComma = NO
Google.Will = NO
Google.Latin = NO

# Ingore Microsoft duplicates
# Ignore Microsoft duplicates
Microsoft.We = NO
Microsoft.FirstPerson = NO
Microsoft.Foreign = NO
Microsoft.Quotes = NO
Microsoft.GeneralURL = NO

# ignore indivudal tokens
# ignore individual tokens
# Ignore the markdown link to check the last word of the link: ](.
# Ignore markdown image with alt: ![
# ignore v#.##
Expand Down
Loading