-
Notifications
You must be signed in to change notification settings - Fork 11
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.
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
Creates The Google Cloud Storage Target Docs #115
Conversation
@JeffNeff where are we on this ? is this still a draft ? |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Also be sure to add this to the list of all targets in the docs
|
||
## Prerequisites | ||
|
||
* A storage bucket is expected to exist prior to running this event target. If you haven't already done so, create a bucket by following the instructions from the [Cloud Storage How-To Guides](https://cloud.google.com/storage/docs/how-to). |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Let's follow the same template as sources. I would like to see these prerequisites as an unordered list. Then you can tell the user how to find them by adding some sections about the prerequisite. Example:
`## Prerequisite(s)
- storage bucket
- service account
Storgae Bucker
A storage bucket is expected to exist prior to running this event target. If you haven't already done so, create a bucket by following the instructions from the Cloud Storage How-To Guides.
`
@JeffNeff could you create an issue for this and link the issue here please |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Do you mind changing the top prerequisites?
Also could you change it to Prerequisite(s)
? This change is currently being made to the templates.
Also not sure if you have seen it. If you write |
Sorry also we have a new rules guide currently being created. Wer are asking for all unordered lists to be |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I don't want to comment on every little detail but I think Dacey said it all. In no particular order:
- The prerequisites (and most of the intro) could easily be copied verbatim from the GC Storage source page and we would end up with consistent doc pages with 0 effort (we can even cross-link screenshots)
- Very large screenshots, I didn't think about it but they do look gigantic in the rendered page
- "Storagel" (typo)
- "GoogleCloudStorage" in one word (in computer programs that's OK, not in docs)
- The section about event types should only list accepted/returned types as in the template. We know our docs lack details about schemas and sooner or later we'll need to tackle that in bulk, but listing attributes via examples or free-form text is not the answer.
Let me know if you need help addressing these.
@@ -0,0 +1,47 @@ | |||
# Event Target for GoogleCloudStorage | |||
This event target integrates with [Google Cloud Storage](https://www.google.com/search?q=google+cloud+storage&oq=google+cloud+storage&aqs=chrome..69i57j0i433l2j69i61l3j69i65l2.1878j1j7&sourceid=chrome&ie=UTF-8), using received Cloud Event messages to create Blob items. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This link can't be right.
#132