-
Notifications
You must be signed in to change notification settings - Fork 2.8k
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
funqy docs disclaimers and usage improvements #10693
Conversation
It would be nice to squash these commits before merging |
Await on #10667 on whether to merge or not. |
9183a0d
to
445473e
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think it's a really good addition to the documentation and clearly explain things.
Can you also add the same WARNING
in the google-cloud-functions-http` guide ?
I added some questions/comments but nothing very important.
381a0a5
to
c18ea69
Compare
c18ea69
to
3464759
Compare
Update docs/src/main/asciidoc/funqy.adoc Co-authored-by: George Gastaldi <[email protected]> Update docs/src/main/asciidoc/funqy.adoc Co-authored-by: Loïc Mathieu <[email protected]> Update docs/src/main/asciidoc/funqy.adoc Co-authored-by: Loïc Mathieu <[email protected]> add links
3464759
to
56fdf50
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM; A good clarification which helps to set expectations right. Thanks, @stuartwdouglas and @patriot1burke. One suggestion inline.
|
||
include::./status-include.adoc[] | ||
|
||
Follow the link:amazon-lambda-http[Amazon Lambda Http Guide]. It walks through using a variety of HTTP | ||
frameworks on Amazon Lambda, including Funqy. | ||
|
||
WARNING: The Funqy HTTP + AWS Lambda binding is not a replacement for REST over HTTP. Because Funqy |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Small suggestion; I'd put this into an admonition block (here and the other occurrences):
[NOTE]
====
The Funqy HTTP + AWS Lambda binding...
====
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Well, it is an admonition, it just uses the shortcut. I think it's good enough this way.
There's been some confusion on when to use Funqy, especially with HTTP. Also, the docs were misleading users into thinking that the AwsContext interface could be injected in Lambda environments.