GoogleCloudPlatform / nodejs-docs-samples

Node.js samples for Google Cloud Platform products.
https://cloud.google.com/nodejs
Apache License 2.0
2.81k stars 1.95k forks source link

Adding Readme for eventarc samples #2575

Closed gcp-grauj closed 8 months ago

gcp-grauj commented 2 years ago

There is no Readme documents for all the samples under the eventarc/ folder.

Some of these samples are used on the official Eventarc docs, but some are not (for example, the generic sample it's not documented).

Would it be possible to add a short readme for each of these samples, or one for all of them, explaining the usage and goal for each of the samples on that folder [1]?

Thanks in advance!

[1] https://github.com/GoogleCloudPlatform/nodejs-docs-samples/tree/main/eventarc

chingor13 commented 2 years ago

@grant It looks like you authored these awhile back - can you take a look?

grant commented 2 years ago

Hi @gcp-grauj, I hope these samples are useful! Yes, not all of them are used in the docs.

The generic sample can be used with any eventarc trigger. Here is some example setup for a related sample: https://github.com/GoogleCloudPlatform/nodejs-docs-samples/tree/main/eventarc/pubsub

grant commented 2 years ago

@chingor13 Thanks. I no longer work on this, however I added a reply.

In terms of owners, I'd contact the serverless DPE folks and add them to https://github.com/GoogleCloudPlatform/nodejs-docs-samples/blob/main/CODEOWNERS for further work.

pattishin commented 8 months ago

Closing out as request is ~2 years old.