From fa9c1b94e6592512c31cfcb9351ef0490d06f4e5 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Lo=C3=AFc=20Mathieu?= Date: Mon, 6 Dec 2021 20:03:24 +0100 Subject: [PATCH] Improve funky doc Add Google Cloud Function. Add the package of the CloudEvent interface. --- docs/src/main/asciidoc/funqy-knative-events.adoc | 2 +- docs/src/main/asciidoc/funqy.adoc | 7 ++++--- 2 files changed, 5 insertions(+), 4 deletions(-) diff --git a/docs/src/main/asciidoc/funqy-knative-events.adoc b/docs/src/main/asciidoc/funqy-knative-events.adoc index 03a30b0424bbe..1424c32d8f45b 100644 --- a/docs/src/main/asciidoc/funqy-knative-events.adoc +++ b/docs/src/main/asciidoc/funqy-knative-events.adoc @@ -164,7 +164,7 @@ There are two things to notice about this function. One, it has no output. You required to return output. Second, there is an additional `event` parameter to the function. If you want to know additional information about the incoming Cloud Event, you can inject the -`CloudEvent` interface using the Funqy `@Context` annotation. The `CloudEvent` interface exposes information +`io.quarkus.funqy.knative.events.CloudEvent` interface using the Funqy `@Context` annotation. The `CloudEvent` interface exposes information about the triggering event. [source, java] diff --git a/docs/src/main/asciidoc/funqy.adoc b/docs/src/main/asciidoc/funqy.adoc index 980254bc5bef2..40838227a1c2f 100644 --- a/docs/src/main/asciidoc/funqy.adoc +++ b/docs/src/main/asciidoc/funqy.adoc @@ -9,8 +9,8 @@ include::./attributes.adoc[] :extension-status: preview Quarkus Funqy is part of Quarkus's serverless strategy and aims to provide a portable Java API to write functions -deployable to various FaaS environments like AWS Lambda, Azure Functions, Knative, and Knative Events (Cloud Events). It is also -usable as a standalone service. +deployable to various FaaS environments like AWS Lambda, Azure Functions, Google Cloud Functions, Knative, and Knative Events (Cloud Events). +It is also usable as a standalone service. Because Funqy is an abstraction that spans multiple different cloud/function providers and protocols it has to be a very simple API and thus, might not have all the features you are used @@ -145,13 +145,14 @@ contextual information that is specific to the environment you are deploying in. NOTE: We do not recommend injecting contextual information specific to a runtime. Keep your functions portable. Contextual information is injected via the `@Context` annotation which can be used on a function parameter -or a class field. A good example is the `CloudEvent` interface that comes with our Funqy +or a class field. A good example is the `io.quarkus.funqy.knative.events.CloudEvent` interface that comes with our Funqy Knative Cloud Events integration: [source, java] ---- import io.quarkus.funqy.Funq; import io.quarkus.funqy.Context; +import io.quarkus.funqy.knative.events.CloudEvent; public class GreetingFunction {