From 2be381f81b54b9bb4d5980b7e28c0c30549f4205 Mon Sep 17 00:00:00 2001 From: Ace Nassri Date: Wed, 7 Dec 2022 05:01:46 -0800 Subject: [PATCH] feat(functions): add READMEs to defragged files (#8791) --- functions/concepts-after-timeout/README.md | 10 ++++++++++ functions/concepts-filesystem/README.md | 10 ++++++++++ functions/concepts-requests/README.md | 10 ++++++++++ functions/concepts-stateless/README.md | 10 ++++++++++ functions/tips-avoid-infinite-retries/README.md | 12 ++++++++++++ functions/tips-connection-pooling/README.md | 12 ++++++++++++ functions/tips-gcp-apis/README.md | 12 ++++++++++++ functions/tips-lazy-globals/README.md | 12 ++++++++++++ functions/tips-retry/README.md | 12 ++++++++++++ functions/tips-scopes/README.md | 12 ++++++++++++ 10 files changed, 112 insertions(+) create mode 100644 functions/concepts-after-timeout/README.md create mode 100644 functions/concepts-filesystem/README.md create mode 100644 functions/concepts-requests/README.md create mode 100644 functions/concepts-stateless/README.md create mode 100644 functions/tips-avoid-infinite-retries/README.md create mode 100644 functions/tips-connection-pooling/README.md create mode 100644 functions/tips-gcp-apis/README.md create mode 100644 functions/tips-lazy-globals/README.md create mode 100644 functions/tips-retry/README.md create mode 100644 functions/tips-scopes/README.md diff --git a/functions/concepts-after-timeout/README.md b/functions/concepts-after-timeout/README.md new file mode 100644 index 000000000000..61e2c87e2633 --- /dev/null +++ b/functions/concepts-after-timeout/README.md @@ -0,0 +1,10 @@ +Google Cloud Platform logo + +# Google Cloud Functions - Timeout sample + +See: + +* [Cloud Functions Execution Timeline][tutorial] +* [Sample Code](main.py) + +[tutorial]: https://cloud.google.com/functions/docs/concepts/execution-environment#execution-timeline diff --git a/functions/concepts-filesystem/README.md b/functions/concepts-filesystem/README.md new file mode 100644 index 000000000000..d48a3cb5d04c --- /dev/null +++ b/functions/concepts-filesystem/README.md @@ -0,0 +1,10 @@ +Google Cloud Platform logo + +# Google Cloud Functions - Filesystem sample + +See: + +* [Cloud Functions Filesystem][tutorial] +* [Sample Code](main.py) + +[tutorial]: https://cloud.google.com/functions/docs/concepts/execution-environment#memory-file-system diff --git a/functions/concepts-requests/README.md b/functions/concepts-requests/README.md new file mode 100644 index 000000000000..f5fba6060372 --- /dev/null +++ b/functions/concepts-requests/README.md @@ -0,0 +1,10 @@ +Google Cloud Platform logo + +# Google Cloud Functions - Requests sample + +See: + +* [Cloud Functions Networking][tutorial] +* [Sample Code](main.py) + +[tutorial]: https://cloud.google.com/functions/docs/concepts/execution-environment#network diff --git a/functions/concepts-stateless/README.md b/functions/concepts-stateless/README.md new file mode 100644 index 000000000000..46c86a9ec93d --- /dev/null +++ b/functions/concepts-stateless/README.md @@ -0,0 +1,10 @@ +Google Cloud Platform logo + +# Google Cloud Functions - Statelessness sample + +See: + +* [Cloud Functions Statelessness][tutorial] +* [Sample Code](main.py) + +[tutorial]: https://cloud.google.com/functions/docs/concepts/execution-environment#statelessness diff --git a/functions/tips-avoid-infinite-retries/README.md b/functions/tips-avoid-infinite-retries/README.md new file mode 100644 index 000000000000..ece27fb0f99b --- /dev/null +++ b/functions/tips-avoid-infinite-retries/README.md @@ -0,0 +1,12 @@ +Google Cloud Platform logo + +# Google Cloud Functions - Avoiding Infinite Retries sample + +## More info +See: + +* [Retrying Event-Driven Functions][tutorial] +* [Sample code][code] + +[tutorial]: https://cloud.google.com/functions/docs/bestpractices/retries#set_an_end_condition_to_avoid_infinite_retry_loops +[code]: main.py diff --git a/functions/tips-connection-pooling/README.md b/functions/tips-connection-pooling/README.md new file mode 100644 index 000000000000..64d9b2a5dda0 --- /dev/null +++ b/functions/tips-connection-pooling/README.md @@ -0,0 +1,12 @@ +Google Cloud Platform logo + +# Google Cloud Functions - Connection Pooling sample + +## More info +See: + +* [Optimizing Networking][tutorial] +* [Sample code][code] + +[tutorial]: https://cloud.google.com/functions/docs/bestpractices/networking#maintaining_persistent_connections +[code]: main.py diff --git a/functions/tips-gcp-apis/README.md b/functions/tips-gcp-apis/README.md new file mode 100644 index 000000000000..6e440112cb52 --- /dev/null +++ b/functions/tips-gcp-apis/README.md @@ -0,0 +1,12 @@ +Google Cloud Platform logo + +# Google Cloud Functions - GCP APIs sample + +## More info +See: + +* [Optimizing Networking][tutorial] +* [Sample code][code] + +[tutorial]: https://cloud.google.com/functions/docs/bestpractices/networking#maintaining_persistent_connections +[code]: main.py diff --git a/functions/tips-lazy-globals/README.md b/functions/tips-lazy-globals/README.md new file mode 100644 index 000000000000..2ae5b5466453 --- /dev/null +++ b/functions/tips-lazy-globals/README.md @@ -0,0 +1,12 @@ +Google Cloud Platform logo + +# Google Cloud Functions - Lazy Globals sample + +## More info +See: + +* [Tips & Tricks for Cloud Functions][tutorial] +* [Sample code][code] + +[tutorial]: https://cloud.google.com/functions/docs/bestpractices/tips#use_global_variables_to_reuse_objects_in_future_invocations +[code]: main.py diff --git a/functions/tips-retry/README.md b/functions/tips-retry/README.md new file mode 100644 index 000000000000..8e9ddf0cc9e5 --- /dev/null +++ b/functions/tips-retry/README.md @@ -0,0 +1,12 @@ +Google Cloud Platform logo + +# Google Cloud Functions - Retries sample + +## More info +See: + +* [Retrying Event-Driven Functions][tutorial] +* [Sample code][code] + +[tutorial]: https://cloud.google.com/functions/docs/bestpractices/retries +[code]: main.py diff --git a/functions/tips-scopes/README.md b/functions/tips-scopes/README.md new file mode 100644 index 000000000000..4fd181329f1f --- /dev/null +++ b/functions/tips-scopes/README.md @@ -0,0 +1,12 @@ +Google Cloud Platform logo + +# Google Cloud Functions - Variable Scope sample + +## More info +See: + +* [Cloud Functions Execution Environment][tutorial] +* [Sample code][code] + +[tutorial]: https://cloud.google.com/functions/docs/concepts/execution-environment#scope +[code]: main.py