chore: add missing readmes for functions samples (#1612)

bshaffer · web-flow · commit 9a8f064b932c · 2022-04-08T18:14:06.000-07:00
diff --git a/functions/README.md b/functions/README.md
@@ -0,0 +1,22 @@
+<img src="https://avatars2.githubusercontent.com/u/2810941?v=3&s=96" alt="Google Cloud Platform logo" title="Google Cloud Platform" align="right" height="96" width="96"/>
+
+# Google Cloud Functions samples
+
+This directory contains samples for Google Cloud Functions. Each sample can be run locally by calling the following:
+
+```
+cd SAMPLE_DIR
+composer install
+composer start
+```
+
+Each sample can be deloyed to Google Cloud Functions by calling the following:
+
+```sh
+cd SAMPLE_DIR
+gcloud functions deploy FUNCTION_NAME --runtime php81 --trigger-http --allow-unauthenticated
+```
+
+For more information, see
+[Create and deploy a Cloud Function by using the Google Cloud CLI](https://cloud.google.com/functions/docs/create-deploy-gcloud), or see the
+[list of all Cloud Functions samples](https://cloud.google.com/functions/docs/samples).
diff --git a/functions/concepts_build_extension/README.md b/functions/concepts_build_extension/README.md
@@ -0,0 +1,5 @@
+<img src="https://avatars2.githubusercontent.com/u/2810941?v=3&s=96" alt="Google Cloud Platform logo" title="Google Cloud Platform" align="right" height="96" width="96"/>
+
+# Google Cloud Functions Build Custom Extensions sample
+
+Build and Deploy a PHP C-Extension in Cloud Functions
diff --git a/functions/concepts_filesystem/README.md b/functions/concepts_filesystem/README.md
@@ -0,0 +1,11 @@
+<img src="https://avatars2.githubusercontent.com/u/2810941?v=3&s=96" alt="Google Cloud Platform logo" title="Google Cloud Platform" align="right" height="96" width="96"/>
+
+# Google Cloud Functions File System sample
+
+This simple tutorial demonstrates how to access a Cloud Functions instance's file system.
+
+- View the [source code][code].
+- See the [tutorial].
+
+[code]: index.php
+[tutorial]: https://cloud.google.com/functions/docs/samples/functions-concepts-filesystem
diff --git a/functions/concepts_requests/README.md b/functions/concepts_requests/README.md
@@ -0,0 +1,11 @@
+<img src="https://avatars2.githubusercontent.com/u/2810941?v=3&s=96" alt="Google Cloud Platform logo" title="Google Cloud Platform" align="right" height="96" width="96"/>
+
+# Google Cloud Functions Send HTTP Requests sample
+
+This simple tutorial demonstrates how to make an HTTP request from a Cloud Function.
+
+- View the [source code][code].
+- See the [tutorial].
+
+[code]: index.php
+[tutorial]: https://cloud.google.com/functions/docs/samples/functions-concepts-requests
diff --git a/functions/env_vars/README.md b/functions/env_vars/README.md
@@ -0,0 +1,11 @@
+<img src="https://avatars2.githubusercontent.com/u/2810941?v=3&s=96" alt="Google Cloud Platform logo" title="Google Cloud Platform" align="right" height="96" width="96"/>
+
+# Google Cloud Functions Environment Variables sample
+
+This simple tutorial demonstrates how to use environment variables within a Cloud Function.
+
+- View the [source code][code].
+- See the [tutorial].
+
+[code]: index.php
+[tutorial]: https://cloud.google.com/functions/docs/samples/functions-env-vars
diff --git a/functions/firebase_analytics/README.md b/functions/firebase_analytics/README.md
@@ -0,0 +1,11 @@
+<img src="https://avatars2.githubusercontent.com/u/2810941?v=3&s=96" alt="Google Cloud Platform logo" title="Google Cloud Platform" align="right" height="96" width="96"/>
+
+# Google Cloud Functions Firebase Analytics sample
+
+This simple tutorial demonstrates how to trigger a function when a Firebase Analytics event is received.
+
+- View the [source code][code].
+- See the [tutorial].
+
+[code]: index.php
+[tutorial]: https://cloud.google.com/functions/docs/samples/functions-firebase-analytics
diff --git a/functions/firebase_auth/README.md b/functions/firebase_auth/README.md
@@ -0,0 +1,11 @@
+<img src="https://avatars2.githubusercontent.com/u/2810941?v=3&s=96" alt="Google Cloud Platform logo" title="Google Cloud Platform" align="right" height="96" width="96"/>
+
+# Google Cloud Functions Firebase Auth sample
+
+This simple tutorial demonstrates how to trigger a function when a Firebase Auth user object changes.
+
+- View the [source code][code].
+- See the [tutorial].
+
+[code]: index.php
+[tutorial]: https://cloud.google.com/functions/docs/samples/functions-firebase-auth
diff --git a/functions/firebase_firestore/README.md b/functions/firebase_firestore/README.md
@@ -0,0 +1,11 @@
+<img src="https://avatars2.githubusercontent.com/u/2810941?v=3&s=96" alt="Google Cloud Platform logo" title="Google Cloud Platform" align="right" height="96" width="96"/>
+
+# Google Cloud Functions Firestore trigger sample
+
+This simple tutorial demonstrates how to trigger a function in response to a Firestore database update.
+
+- View the [source code][code].
+- See the [tutorial].
+
+[code]: index.php
+[tutorial]: https://cloud.google.com/functions/docs/samples/functions-firebase-firestore
diff --git a/functions/firebase_firestore_reactive/README.md b/functions/firebase_firestore_reactive/README.md
@@ -0,0 +1,11 @@
+<img src="https://avatars2.githubusercontent.com/u/2810941?v=3&s=96" alt="Google Cloud Platform logo" title="Google Cloud Platform" align="right" height="96" width="96"/>
+
+# Google Cloud Functions Firebase React to value change sample
+
+This simple tutorial demonstrates how to react to value change by updating a value in Firestore
+
+- View the [source code][code].
+- See the [tutorial].
+
+[code]: index.php
+[tutorial]: https://cloud.google.com/functions/docs/samples/functions-firebase-reactive
diff --git a/functions/firebase_remote_config/README.md b/functions/firebase_remote_config/README.md
@@ -0,0 +1,11 @@
+<img src="https://avatars2.githubusercontent.com/u/2810941?v=3&s=96" alt="Google Cloud Platform logo" title="Google Cloud Platform" align="right" height="96" width="96"/>
+
+# Google Cloud Functions Firebase Remote Config sample
+
+This simple tutorial demonstrates how to process changes to Firebase remote config values.
+
+- View the [source code][code].
+- See the [tutorial].
+
+[code]: index.php
+[tutorial]: https://cloud.google.com/functions/docs/samples/functions-firebase-remote-config
diff --git a/functions/firebase_rtdb/README.md b/functions/firebase_rtdb/README.md
@@ -0,0 +1,11 @@
+<img src="https://avatars2.githubusercontent.com/u/2810941?v=3&s=96" alt="Google Cloud Platform logo" title="Google Cloud Platform" align="right" height="96" width="96"/>
+
+# Google Cloud Functions Firebase RTDB Trigger sample
+
+This simple tutorial demonstrates how to trigger a function when a Firebase realtime database is updated.
+
+- View the [source code][code].
+- See the [tutorial].
+
+[code]: index.php
+[tutorial]: https://cloud.google.com/functions/docs/samples/functions-firebase-rtdb
diff --git a/functions/helloworld_get/README.md b/functions/helloworld_get/README.md
@@ -0,0 +1,11 @@
+<img src="https://avatars2.githubusercontent.com/u/2810941?v=3&s=96" alt="Google Cloud Platform logo" title="Google Cloud Platform" align="right" height="96" width="96"/>
+
+# Google Cloud Functions HTTP Hello World - Get sample
+
+Function that prints "Hello world!" in response to a GET request.
+
+- View the [source code][code].
+- See the [tutorial].
+
+[code]: index.php
+[tutorial]: https://cloud.google.com/functions/docs/samples/functions-helloworld-get
diff --git a/functions/helloworld_http/README.md b/functions/helloworld_http/README.md
@@ -0,0 +1,11 @@
+<img src="https://avatars2.githubusercontent.com/u/2810941?v=3&s=96" alt="Google Cloud Platform logo" title="Google Cloud Platform" align="right" height="96" width="96"/>
+
+# Google Cloud Functions HTTP Hello World sample
+
+HTTP function responds with "Hello, world!"
+
+- View the [source code][code].
+- See the [tutorial].
+
+[code]: index.php
+[tutorial]: https://cloud.google.com/functions/docs/samples/functions-helloworld-http
diff --git a/functions/helloworld_log/README.md b/functions/helloworld_log/README.md
@@ -0,0 +1,11 @@
+<img src="https://avatars2.githubusercontent.com/u/2810941?v=3&s=96" alt="Google Cloud Platform logo" title="Google Cloud Platform" align="right" height="96" width="96"/>
+
+# Google Cloud Functions Write Logs sample
+
+DThis simple tutorial demonstrates how to write a Cloud Functions log entry.
+
+- View the [source code][code].
+- See the [tutorial].
+
+[code]: index.php
+[tutorial]: https://cloud.google.com/functions/docs/samples/functions-log-helloworld
diff --git a/functions/helloworld_pubsub/README.md b/functions/helloworld_pubsub/README.md
@@ -0,0 +1,11 @@
+<img src="https://avatars2.githubusercontent.com/u/2810941?v=3&s=96" alt="Google Cloud Platform logo" title="Google Cloud Platform" align="right" height="96" width="96"/>
+
+# Google Cloud Functions Pub/Sub sample
+
+This simple tutorial demonstrates writing, deploying, and triggering an Event-Driven Cloud Function with a Cloud Pub/Sub trigger.
+
+- View the [source code][code].
+- See the [tutorial].
+
+[code]: index.php
+[tutorial]: https://cloud.google.com/functions/docs/tutorials/pubsub
diff --git a/functions/helloworld_storage/README.md b/functions/helloworld_storage/README.md
@@ -0,0 +1,13 @@
+<img src="https://avatars2.githubusercontent.com/u/2810941?v=3&s=96" alt="Google Cloud Platform logo" title="Google Cloud Platform" align="right" height="96" width="96"/>
+
+# Google Cloud Functions Cloud Storage sample
+
+This simple tutorial demonstrates writing, deploying, and triggering an
+Event-Driven Cloud Function with a Cloud Storage trigger to respond to
+Cloud Storage events.
+
+- View the [source code][code].
+- See the [tutorial].
+
+[code]: index.php
+[tutorial]: https://cloud.google.com/functions/docs/tutorials/storage
diff --git a/functions/http_content_type/README.md b/functions/http_content_type/README.md
@@ -0,0 +1,11 @@
+<img src="https://avatars2.githubusercontent.com/u/2810941?v=3&s=96" alt="Google Cloud Platform logo" title="Google Cloud Platform" align="right" height="96" width="96"/>
+
+# Google Cloud Functions HTTP request body sample
+
+This simple tutorial demonstrates how to parse a request body.
+
+- View the [source code][code].
+- See the [tutorial].
+
+[code]: index.php
+[tutorial]: https://cloud.google.com/functions/docs/samples/functions-http-content
diff --git a/functions/http_cors/README.md b/functions/http_cors/README.md
@@ -0,0 +1,11 @@
+<img src="https://avatars2.githubusercontent.com/u/2810941?v=3&s=96" alt="Google Cloud Platform logo" title="Google Cloud Platform" align="right" height="96" width="96"/>
+
+# Google Cloud Functions HTTP CORS sample
+
+This simple tutorial demonstrates how to make CORS-enabled requests with Cloud Functions.
+
+- View the [source code][code].
+- See the [tutorial].
+
+[code]: index.php
+[tutorial]: https://cloud.google.com/functions/docs/samples/functions-http-cors
diff --git a/functions/http_form_data/README.md b/functions/http_form_data/README.md
@@ -0,0 +1,11 @@
+<img src="https://avatars2.githubusercontent.com/u/2810941?v=3&s=96" alt="Google Cloud Platform logo" title="Google Cloud Platform" align="right" height="96" width="96"/>
+
+# Google Cloud Functions HTTP forms sample
+
+This simple tutorial demonstrates how to parse HTTP form requests.
+
+- View the [source code][code].
+- See the [tutorial].
+
+[code]: index.php
+[tutorial]: https://cloud.google.com/functions/docs/samples/functions-http-form-data
diff --git a/functions/http_method/README.md b/functions/http_method/README.md
@@ -0,0 +1,11 @@
+<img src="https://avatars2.githubusercontent.com/u/2810941?v=3&s=96" alt="Google Cloud Platform logo" title="Google Cloud Platform" align="right" height="96" width="96"/>
+
+# Google Cloud Functions HTTP method types sample
+
+Shows how to handle HTTP method types (such as GET, PUT, and POST) in Cloud Functions.
+
+- View the [source code][code].
+- See the [tutorial].
+
+[code]: index.php
+[tutorial]: https://cloud.google.com/functions/docs/samples/functions-http-method
diff --git a/functions/slack_slash_command/README.md b/functions/slack_slash_command/README.md
@@ -0,0 +1,12 @@
+<img src="https://avatars2.githubusercontent.com/u/2810941?v=3&s=96" alt="Google Cloud Platform logo" title="Google Cloud Platform" align="right" height="96" width="96"/>
+
+# Google Cloud Functions Slack sample
+
+This tutorial demonstrates using Cloud Functions to implement a
+Slack Slash Command that searches the Google Knowledge Graph API.
+
+- View the [source code][code].
+- See the [tutorial].
+
+[code]: index.php
+[tutorial]: https://cloud.google.com/functions/docs/tutorials/slack
diff --git a/functions/tips_infinite_retries/README.md b/functions/tips_infinite_retries/README.md
@@ -0,0 +1,11 @@
+<img src="https://avatars2.githubusercontent.com/u/2810941?v=3&s=96" alt="Google Cloud Platform logo" title="Google Cloud Platform" align="right" height="96" width="96"/>
+
+# Google Cloud Functions Avoid Infinite Retries sample
+
+This simple tutorial demonstrates how to discard all events older than 10 seconds.
+
+- View the [source code][code].
+- See the [tutorial].
+
+[code]: index.php
+[tutorial]: https://cloud.google.com/functions/docs/samples/functions-tips-infinite-retries
diff --git a/functions/tips_phpinfo/README.md b/functions/tips_phpinfo/README.md
@@ -0,0 +1,11 @@
+<img src="https://avatars2.githubusercontent.com/u/2810941?v=3&s=96" alt="Google Cloud Platform logo" title="Google Cloud Platform" align="right" height="96" width="96"/>
+
+# Google Cloud Functions PHPInfo sample
+
+This simple tutorial demonstrates how to get PHP info
+
+- View the [source code][code].
+- See the [tutorial].
+
+[code]: index.php
+[tutorial]: https://cloud.google.com/functions/docs/samples/functions-tips-phpinfo
diff --git a/functions/tips_retry/README.md b/functions/tips_retry/README.md
@@ -0,0 +1,11 @@
+<img src="https://avatars2.githubusercontent.com/u/2810941?v=3&s=96" alt="Google Cloud Platform logo" title="Google Cloud Platform" align="right" height="96" width="96"/>
+
+# Google Cloud Functions Retry on Error sample
+
+This simple tutorial demonstrates how to tell your function whether or not to retry execution when an error happens.
+
+- View the [source code][code].
+- See the [tutorial].
+
+[code]: index.php
+[tutorial]: https://cloud.google.com/functions/docs/samples/functions-tips-retry#functions_tips_retry-php
diff --git a/functions/tips_scopes/README.md b/functions/tips_scopes/README.md
@@ -0,0 +1,11 @@
+<img src="https://avatars2.githubusercontent.com/u/2810941?v=3&s=96" alt="Google Cloud Platform logo" title="Google Cloud Platform" align="right" height="96" width="96"/>
+
+# Google Cloud Functions Global vs Function Scope sample
+
+This simple tutorial creates a heavy object only once per function instance, and shares it across all function invocations reaching the given instance.
+
+- View the [source code][code].
+- See the [tutorial].
+
+[code]: index.php
+[tutorial]: https://cloud.google.com/functions/docs/samples/functions-tips-scopes
