Updates the Data Prepper S3 source documentation #3813
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…ructions for usage and new features in 2.2. Includes some clean-up as well. Signed-off-by: David Venable <[email protected]>
|
@carolxob , @Naarcha-AWS : I created this PR to help with the S3 source documentation. |
Signed-off-by: Naarcha-AWS <[email protected]>
Naarcha-AWS
requested review from
ariamarble,
carolxob,
cwillum,
hdhalter,
JeffHuss,
kolchfa-aws,
Naarcha-AWS,
vagimeli,
ananzh,
seanneumann,
AMoo-Miki and
natebower
as code owners
|
@dlvenable: Added edits to the grammar and formatting. Going to pass this into Doc review now. |
Naarcha-AWS
added
4 - Doc review
carolxob
reviewed
Apr 25, 2023
carolxob
reviewed
Apr 25, 2023
carolxob
reviewed
Apr 25, 2023
carolxob
reviewed
Apr 25, 2023
carolxob
reviewed
Apr 25, 2023
Co-authored-by: Caroline <[email protected]> Signed-off-by: Naarcha-AWS <[email protected]>
Co-authored-by: Caroline <[email protected]> Signed-off-by: Naarcha-AWS <[email protected]>
Co-authored-by: Caroline <[email protected]> Signed-off-by: Naarcha-AWS <[email protected]>
Co-authored-by: Caroline <[email protected]> Signed-off-by: Naarcha-AWS <[email protected]>
Co-authored-by: Caroline <[email protected]> Signed-off-by: Naarcha-AWS <[email protected]>
Naarcha-AWS
reviewed
Apr 25, 2023
Signed-off-by: Naarcha-AWS <[email protected]>
Implement Caroline's feedback
Naarcha-AWS
added
5 - Editorial review
natebower
requested changes
Apr 25, 2023
There was a problem hiding this comment.
@Naarcha-AWS Please see my comments and changes and tag me on just the text we add to introduce the tables so that I can approve. Thanks!
|
|
||
| Option | Required | Type | Description | ||
| :--- |:---------|:------------| :--- | ||
| type | No | String | The type of JSON. May be either `DOCUMENT` or `LINES`. Maps directly to the [Type](https://docs.aws.amazon.com/AmazonS3/latest/API/API_JSONInput.html#AmazonS3-Type-JSONInput-Type) property. |
There was a problem hiding this comment.
Insert the noun after "JSON". The type of JSON what?
|
|
||
| ## Example: Uncompressed logs | ||
|
|
||
| The following pipeline.yaml shows a minimum configuration for reading uncompressed newline-delimited logs. |
There was a problem hiding this comment.
"the" minimum configuration?
Naarcha-AWS
reviewed
Apr 25, 2023
Naarcha-AWS
reviewed
Apr 25, 2023
Co-authored-by: Nathan Bower <[email protected]> Signed-off-by: Naarcha-AWS <[email protected]>
Naarcha-AWS
approved these changes
Apr 25, 2023
Signed-off-by: Naarcha-AWS <[email protected]>
Signed-off-by: Naarcha-AWS <[email protected]>
Co-authored-by: Nathan Bower <[email protected]> Signed-off-by: Naarcha-AWS <[email protected]>
Naarcha-AWS
reviewed
Apr 25, 2023
Signed-off-by: Naarcha-AWS <[email protected]>
opensearch-trigger-bot bot
pushed a commit
that referenced
this pull request
Apr 25, 2023
* Updates the Data Prepper S3 source documentation with additional instructions for usage and new features in 2.2. Includes some clean-up as well. Signed-off-by: David Venable <[email protected]> * Add back in example * Update _data-prepper/pipelines/configuration/sources/s3.md Co-authored-by: Caroline <[email protected]> Signed-off-by: Naarcha-AWS <[email protected]> * Update _data-prepper/pipelines/configuration/sources/s3.md Co-authored-by: Caroline <[email protected]> Signed-off-by: Naarcha-AWS <[email protected]> * Update _data-prepper/pipelines/configuration/sources/s3.md Co-authored-by: Caroline <[email protected]> Signed-off-by: Naarcha-AWS <[email protected]> * Update _data-prepper/pipelines/configuration/sources/s3.md Co-authored-by: Caroline <[email protected]> Signed-off-by: Naarcha-AWS <[email protected]> * Update s3.md * Apply suggestions from code review Co-authored-by: Caroline <[email protected]> Signed-off-by: Naarcha-AWS <[email protected]> * Update _data-prepper/pipelines/configuration/sources/s3.md Signed-off-by: Naarcha-AWS <[email protected]> * Update s3.md Implement Caroline's feedback * Apply suggestions from code review Co-authored-by: Nathan Bower <[email protected]> Signed-off-by: Naarcha-AWS <[email protected]> * Update _data-prepper/pipelines/configuration/sources/s3.md Signed-off-by: Naarcha-AWS <[email protected]> * Update _data-prepper/pipelines/configuration/sources/s3.md Signed-off-by: Naarcha-AWS <[email protected]> * Update _data-prepper/pipelines/configuration/sources/s3.md Co-authored-by: Nathan Bower <[email protected]> Signed-off-by: Naarcha-AWS <[email protected]> * Update _data-prepper/pipelines/configuration/sources/s3.md Signed-off-by: Naarcha-AWS <[email protected]> --------- Signed-off-by: David Venable <[email protected]> Signed-off-by: Naarcha-AWS <[email protected]> Co-authored-by: Naarcha-AWS <[email protected]> Co-authored-by: Caroline <[email protected]> Co-authored-by: Nathan Bower <[email protected]> (cherry picked from commit aa2033c) Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
opensearch-trigger-bot bot
pushed a commit
that referenced
this pull request
Apr 25, 2023
* Updates the Data Prepper S3 source documentation with additional instructions for usage and new features in 2.2. Includes some clean-up as well. Signed-off-by: David Venable <[email protected]> * Add back in example * Update _data-prepper/pipelines/configuration/sources/s3.md Co-authored-by: Caroline <[email protected]> Signed-off-by: Naarcha-AWS <[email protected]> * Update _data-prepper/pipelines/configuration/sources/s3.md Co-authored-by: Caroline <[email protected]> Signed-off-by: Naarcha-AWS <[email protected]> * Update _data-prepper/pipelines/configuration/sources/s3.md Co-authored-by: Caroline <[email protected]> Signed-off-by: Naarcha-AWS <[email protected]> * Update _data-prepper/pipelines/configuration/sources/s3.md Co-authored-by: Caroline <[email protected]> Signed-off-by: Naarcha-AWS <[email protected]> * Update s3.md * Apply suggestions from code review Co-authored-by: Caroline <[email protected]> Signed-off-by: Naarcha-AWS <[email protected]> * Update _data-prepper/pipelines/configuration/sources/s3.md Signed-off-by: Naarcha-AWS <[email protected]> * Update s3.md Implement Caroline's feedback * Apply suggestions from code review Co-authored-by: Nathan Bower <[email protected]> Signed-off-by: Naarcha-AWS <[email protected]> * Update _data-prepper/pipelines/configuration/sources/s3.md Signed-off-by: Naarcha-AWS <[email protected]> * Update _data-prepper/pipelines/configuration/sources/s3.md Signed-off-by: Naarcha-AWS <[email protected]> * Update _data-prepper/pipelines/configuration/sources/s3.md Co-authored-by: Nathan Bower <[email protected]> Signed-off-by: Naarcha-AWS <[email protected]> * Update _data-prepper/pipelines/configuration/sources/s3.md Signed-off-by: Naarcha-AWS <[email protected]> --------- Signed-off-by: David Venable <[email protected]> Signed-off-by: Naarcha-AWS <[email protected]> Co-authored-by: Naarcha-AWS <[email protected]> Co-authored-by: Caroline <[email protected]> Co-authored-by: Nathan Bower <[email protected]> (cherry picked from commit aa2033c) Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
Naarcha-AWS
added a commit
that referenced
this pull request
Apr 25, 2023
* Updates the Data Prepper S3 source documentation with additional instructions for usage and new features in 2.2. Includes some clean-up as well. * Add back in example * Update _data-prepper/pipelines/configuration/sources/s3.md * Update _data-prepper/pipelines/configuration/sources/s3.md * Update _data-prepper/pipelines/configuration/sources/s3.md * Update _data-prepper/pipelines/configuration/sources/s3.md * Update s3.md * Apply suggestions from code review * Update _data-prepper/pipelines/configuration/sources/s3.md * Update s3.md Implement Caroline's feedback * Apply suggestions from code review * Update _data-prepper/pipelines/configuration/sources/s3.md * Update _data-prepper/pipelines/configuration/sources/s3.md * Update _data-prepper/pipelines/configuration/sources/s3.md * Update _data-prepper/pipelines/configuration/sources/s3.md --------- (cherry picked from commit aa2033c) Signed-off-by: David Venable <[email protected]> Signed-off-by: Naarcha-AWS <[email protected]> Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com> Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com> Co-authored-by: Naarcha-AWS <[email protected]> Co-authored-by: Caroline <[email protected]> Co-authored-by: Nathan Bower <[email protected]>
Naarcha-AWS
added a commit
that referenced
this pull request
Apr 25, 2023
* Updates the Data Prepper S3 source documentation with additional instructions for usage and new features in 2.2. Includes some clean-up as well. * Add back in example * Update _data-prepper/pipelines/configuration/sources/s3.md * Update _data-prepper/pipelines/configuration/sources/s3.md * Update _data-prepper/pipelines/configuration/sources/s3.md * Update _data-prepper/pipelines/configuration/sources/s3.md * Update s3.md * Apply suggestions from code review * Update _data-prepper/pipelines/configuration/sources/s3.md * Update s3.md Implement Caroline's feedback * Apply suggestions from code review * Update _data-prepper/pipelines/configuration/sources/s3.md * Update _data-prepper/pipelines/configuration/sources/s3.md * Update _data-prepper/pipelines/configuration/sources/s3.md * Update _data-prepper/pipelines/configuration/sources/s3.md --------- (cherry picked from commit aa2033c) Signed-off-by: David Venable <[email protected]> Signed-off-by: Naarcha-AWS <[email protected]> Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com> Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com> Co-authored-by: Naarcha-AWS <[email protected]> Co-authored-by: Caroline <[email protected]> Co-authored-by: Nathan Bower <[email protected]>
Naarcha-AWS
added a commit
that referenced
this pull request
Apr 27, 2023
* Updates the Data Prepper S3 source documentation with additional instructions for usage and new features in 2.2. Includes some clean-up as well. Signed-off-by: David Venable <[email protected]> * Add back in example * Update _data-prepper/pipelines/configuration/sources/s3.md Co-authored-by: Caroline <[email protected]> Signed-off-by: Naarcha-AWS <[email protected]> * Update _data-prepper/pipelines/configuration/sources/s3.md Co-authored-by: Caroline <[email protected]> Signed-off-by: Naarcha-AWS <[email protected]> * Update _data-prepper/pipelines/configuration/sources/s3.md Co-authored-by: Caroline <[email protected]> Signed-off-by: Naarcha-AWS <[email protected]> * Update _data-prepper/pipelines/configuration/sources/s3.md Co-authored-by: Caroline <[email protected]> Signed-off-by: Naarcha-AWS <[email protected]> * Update s3.md * Apply suggestions from code review Co-authored-by: Caroline <[email protected]> Signed-off-by: Naarcha-AWS <[email protected]> * Update _data-prepper/pipelines/configuration/sources/s3.md Signed-off-by: Naarcha-AWS <[email protected]> * Update s3.md Implement Caroline's feedback * Apply suggestions from code review Co-authored-by: Nathan Bower <[email protected]> Signed-off-by: Naarcha-AWS <[email protected]> * Update _data-prepper/pipelines/configuration/sources/s3.md Signed-off-by: Naarcha-AWS <[email protected]> * Update _data-prepper/pipelines/configuration/sources/s3.md Signed-off-by: Naarcha-AWS <[email protected]> * Update _data-prepper/pipelines/configuration/sources/s3.md Co-authored-by: Nathan Bower <[email protected]> Signed-off-by: Naarcha-AWS <[email protected]> * Update _data-prepper/pipelines/configuration/sources/s3.md Signed-off-by: Naarcha-AWS <[email protected]> --------- Signed-off-by: David Venable <[email protected]> Signed-off-by: Naarcha-AWS <[email protected]> Co-authored-by: Naarcha-AWS <[email protected]> Co-authored-by: Caroline <[email protected]> Co-authored-by: Nathan Bower <[email protected]>
vagimeli
pushed a commit
that referenced
this pull request
May 4, 2023
* Updates the Data Prepper S3 source documentation with additional instructions for usage and new features in 2.2. Includes some clean-up as well. Signed-off-by: David Venable <[email protected]> * Add back in example * Update _data-prepper/pipelines/configuration/sources/s3.md Co-authored-by: Caroline <[email protected]> Signed-off-by: Naarcha-AWS <[email protected]> * Update _data-prepper/pipelines/configuration/sources/s3.md Co-authored-by: Caroline <[email protected]> Signed-off-by: Naarcha-AWS <[email protected]> * Update _data-prepper/pipelines/configuration/sources/s3.md Co-authored-by: Caroline <[email protected]> Signed-off-by: Naarcha-AWS <[email protected]> * Update _data-prepper/pipelines/configuration/sources/s3.md Co-authored-by: Caroline <[email protected]> Signed-off-by: Naarcha-AWS <[email protected]> * Update s3.md * Apply suggestions from code review Co-authored-by: Caroline <[email protected]> Signed-off-by: Naarcha-AWS <[email protected]> * Update _data-prepper/pipelines/configuration/sources/s3.md Signed-off-by: Naarcha-AWS <[email protected]> * Update s3.md Implement Caroline's feedback * Apply suggestions from code review Co-authored-by: Nathan Bower <[email protected]> Signed-off-by: Naarcha-AWS <[email protected]> * Update _data-prepper/pipelines/configuration/sources/s3.md Signed-off-by: Naarcha-AWS <[email protected]> * Update _data-prepper/pipelines/configuration/sources/s3.md Signed-off-by: Naarcha-AWS <[email protected]> * Update _data-prepper/pipelines/configuration/sources/s3.md Co-authored-by: Nathan Bower <[email protected]> Signed-off-by: Naarcha-AWS <[email protected]> * Update _data-prepper/pipelines/configuration/sources/s3.md Signed-off-by: Naarcha-AWS <[email protected]> --------- Signed-off-by: David Venable <[email protected]> Signed-off-by: Naarcha-AWS <[email protected]> Co-authored-by: Naarcha-AWS <[email protected]> Co-authored-by: Caroline <[email protected]> Co-authored-by: Nathan Bower <[email protected]>
harshavamsi
pushed a commit
to harshavamsi/documentation-website
that referenced
this pull request
Oct 31, 2023
…3813) * Updates the Data Prepper S3 source documentation with additional instructions for usage and new features in 2.2. Includes some clean-up as well. Signed-off-by: David Venable <[email protected]> * Add back in example * Update _data-prepper/pipelines/configuration/sources/s3.md Co-authored-by: Caroline <[email protected]> Signed-off-by: Naarcha-AWS <[email protected]> * Update _data-prepper/pipelines/configuration/sources/s3.md Co-authored-by: Caroline <[email protected]> Signed-off-by: Naarcha-AWS <[email protected]> * Update _data-prepper/pipelines/configuration/sources/s3.md Co-authored-by: Caroline <[email protected]> Signed-off-by: Naarcha-AWS <[email protected]> * Update _data-prepper/pipelines/configuration/sources/s3.md Co-authored-by: Caroline <[email protected]> Signed-off-by: Naarcha-AWS <[email protected]> * Update s3.md * Apply suggestions from code review Co-authored-by: Caroline <[email protected]> Signed-off-by: Naarcha-AWS <[email protected]> * Update _data-prepper/pipelines/configuration/sources/s3.md Signed-off-by: Naarcha-AWS <[email protected]> * Update s3.md Implement Caroline's feedback * Apply suggestions from code review Co-authored-by: Nathan Bower <[email protected]> Signed-off-by: Naarcha-AWS <[email protected]> * Update _data-prepper/pipelines/configuration/sources/s3.md Signed-off-by: Naarcha-AWS <[email protected]> * Update _data-prepper/pipelines/configuration/sources/s3.md Signed-off-by: Naarcha-AWS <[email protected]> * Update _data-prepper/pipelines/configuration/sources/s3.md Co-authored-by: Nathan Bower <[email protected]> Signed-off-by: Naarcha-AWS <[email protected]> * Update _data-prepper/pipelines/configuration/sources/s3.md Signed-off-by: Naarcha-AWS <[email protected]> --------- Signed-off-by: David Venable <[email protected]> Signed-off-by: Naarcha-AWS <[email protected]> Co-authored-by: Naarcha-AWS <[email protected]> Co-authored-by: Caroline <[email protected]> Co-authored-by: Nathan Bower <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
This PR includes the following changes:
Issues Resolved
N/A
Checklist
For more information on following Developer Certificate of Origin and signing off your commits, please check here.