Updates README for v0.2 and adds cloud run example instructions #21
Conversation
README.md
Outdated
| -t gcr.io/$GCLOUD_PROJECT/my-cloud-function | ||
| ``` | ||
|
|
||
| > **NOTE**: Be sure to replace `$GCLOUD_PROJECT` with your Google Cloud project ID. |
There was a problem hiding this comment.
Often our instructions have them set that first, like:
export PROJECT_ID=$(gcloud config get-value core/project)
There was a problem hiding this comment.
I personally have never seen this, can you point to an example?
Our docs usually have a <var> placeholder, and I've never done this for any PHP readmes.
There was a problem hiding this comment.
Yeah, it's more of the community tutorials that use the easy approach.
There was a problem hiding this comment.
I added it to the notes. I think it'd be better for them to explicitly set it, since it's possible they haven't called gcloud init yet, or they may be in a different project than the one they want to deploy.
| docker build . \ | ||
| -f vendor/google/cloud-functions-framework/examples/hello/Dockerfile \ |
There was a problem hiding this comment.
I think this needs to be:
docker build examples/hello
There was a problem hiding this comment.
This path assumes the library is installed as a vendored dependency. Although even then, it would be cleaner as
docker build vendor/google/cloud-functions-framework/examples/hello \
-t my-cloud-function
There was a problem hiding this comment.
Oh, also, if you do that it uses the index.php in the examples/hello repo, but if you follow the steps in the README, it expects you to create a custom index.php and use that.
The example can be used both ways. We could potentially outline BOTH in the readme (cloning the repo and build the example AND create your own and use composer). But it may be confusing to include both. WDYT?
There was a problem hiding this comment.
Ah, I see. Yeah, both approaches have value. I tend to create examples that are self-contained and runnable without modification.
There was a problem hiding this comment.
I cleaned up the steps so it's clearer that you are deploying one from an application directory.
There was a problem hiding this comment.
I think it's the age-old tradeoff between ensuring the user does something and understands what they're doing, and getting something to work quickly. If they go in and run the example, they'll probably complete the steps faster but not have as strong of a grasp as to why. I think what we have here is a good compromise.
No description provided.