Skip to content

Add information about v2 to readme files #985

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.

Sign up for GitHub

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

Merged
merged 5 commits into from
May 11, 2022
Merged

Add information about v2 to readme files #985

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
4f4d3d5
update root readme
jhuleatt May 11, 2022
bf7ce84
rearrange sample readmes
jhuleatt May 11, 2022
1b31944
address review feedback
jhuleatt May 11, 2022
ff52db3
remove readme from gen2 folder
jhuleatt May 11, 2022
c78425e
oxford comma
jhuleatt May 11, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
0 ...en/callable-functions/functions/README.md → 2nd-gen/callable-functions/README.md
View file
Open in desktop
File renamed without changes.
0 2nd-gen/custom-events/functions/ README.md → 2nd-gen/custom-events/ README.md
View file
Open in desktop
File renamed without changes.
0 ...gen/pubsub-helloworld/functions/README.md → 2nd-gen/pubsub-helloworld/README.md
View file
Open in desktop
File renamed without changes.
42 changes: 42 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@ To learn how to get started with Cloud Functions for Firebase by having a look a
This repository contains a few categories of samples:

1. [**Quickstarts**](#quickstarts) are minimal examples for each types of triggers.
1. [**Cloud Functions v2 public preview**](#v2) samples show how to use the public preview of [Cloud Functions for Firebase v2](https://firebase.google.com/docs/functions/beta).
1. [**Development Environment Samples and Boilerplates**](#environment) illustrates how to get started with
different, commonly used JavaScript development patterns such as Typescript, React SSR, ES2017 etc...
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggest "SSR, and ES2017."

I'd do the same with the next two ellipses below. "Such as" lets you give a few examples, but suggests more.

1. [**Image Processing**](#image) shows a few ways where you can process and transform images using Cloud Functions such as generating thumbnails, converting images extracting metadata...
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This could just be "a few ways you can process"

Expand Down Expand Up @@ -59,6 +60,47 @@ This quickstart sample demonstrates using **Cloud Functions** triggered by **Pub
This quickstart demonstrates how to trigger a function in response to the
completion of a test matrix in **Firebase Test Lab**.

<a name="v2"></a>
## Cloud Functions v2 public preview

> Note: Cloud Functions for Firebase v2 is a public preview. This means that the functionality might change in backward-incompatible ways. A preview release is not subject to any SLA or deprecation policy and may receive limited or no support.

See [the Firebase docs](https://firebase.google.com/docs/functions/beta) for more information about the v2 public preview.

### [HTTPS: Time Server](/2nd-gen/time-server/)

A minimal HTTPS example.

### [Task Queues: Back-up images from an API](/2nd-gen/taskqueues-backup-images/)

See how to use Task Queues to meter traffic to a rate-limited API.

### [Firebase Alerts: Send crash reports to Discord](/2nd-gen/alerts-to-discord/)

Trigger a function based on a Firebase Alert, and send information about the alert to a channel in a Discord server.

### [Custom Events: Save image metadata](/2nd-gen/custom-events/)

Learn how to trigger a function based on an event sent by an extension

### [Callables: Add numbers and sanitize text](/2nd-gen/callable-functions/)

See how to write a v2 function that can easily be triggered from an app.

### [PubSub: Hello world](/2nd-gen/pubsub-helloworld/)

A minimal PubSub example.

### [Storage: Generate image thumbnails](/2nd-gen/thumbnails/)

Resize images after they're added to a Storage bucket.

### Unit testing

- [Test with Jest](/2nd-gen/test-functions-jest/)
- [Test with Jest and TypeScript](/2nd-gen/test-functions-jest-ts/)
- [Test with Mocha](/2nd-gen/test-functions-mocha/)

<a name="environment"></a>
## Development Boilerplates

Expand Down