Skip to content
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

Jump to bottom

[Enhancement] exclude_keys documentation gaps #3162

Closed
engechas opened this issue Aug 14, 2023 · 0 comments · Fixed by #3211
Closed

[Enhancement] exclude_keys documentation gaps #3162

engechas opened this issue Aug 14, 2023 · 0 comments · Fixed by #3211
Assignees
@dlvenable
Labels
documentation Improvements or additions to documentation
Milestone
v2.4

Comments

@engechas
Copy link
Collaborator

There's a few gaps in documentation on include/exclude_keys:

  1. The Avro README shows an example with exclude_keys, but it is not a valid option in the codec. Instead it should be specified as a parameter of the sink.

  2. The S3 sink README does not have a section on include/exclude_keys
@engechas engechas added documentation Improvements or additions to documentation untriaged labels Aug 14, 2023
@dlvenable dlvenable self-assigned this Aug 16, 2023
@dlvenable dlvenable added this to the v2.4 milestone Aug 16, 2023
dlvenable added a commit to dlvenable/data-prepper that referenced this issue Aug 22, 2023
@dlvenable
Updates documentation for the Avro codec and S3 sink. Resolves opense…
f87b93c 
…arch-project#3162.

Signed-off-by: David Venable <[email protected]>
@dlvenable dlvenable mentioned this issue Aug 22, 2023
Merged
4 tasks
dlvenable added a commit that referenced this issue Aug 22, 2023
@dlvenable
Updates documentation for the Avro codec and S3 sink. Resolves #3162. (…
3d67468 
…#3211)

Signed-off-by: David Venable <[email protected]>
opensearch-trigger-bot bot pushed a commit that referenced this issue Aug 22, 2023
@dlvenable @github-actions
Updates documentation for the Avro codec and S3 sink. Resolves #3162. (…
9da31df 
…#3211)

Signed-off-by: David Venable <[email protected]>
(cherry picked from commit 3d67468)
dlvenable added a commit that referenced this issue Aug 22, 2023
@opensearch-trigger-bot @dlvenable
Updates documentation for the Avro codec and S3 sink. Resolves #3162. (…
ed39387 
…#3211) (#3219)

Signed-off-by: David Venable <[email protected]>
(cherry picked from commit 3d67468)

Co-authored-by: David Venable <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@dlvenable dlvenable

Labels
documentation Improvements or additions to documentation
Projects
Data Prepper Tracking Board
Archived in project
Milestone
v2.4
Development

Successfully merging a pull request may close this issue.

Updates documentation for the Avro codec and S3 sink. dlvenable/data-prepper
2 participants
@dlvenable @engechas