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.

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

[Data Prepper] MAINT: add HTML comment on obfuscate processor config table #7651

Conversation

chenqi0805
Copy link
Contributor

Description

This serves as a starter to auto-generate config table from our source repo

Issues Resolved

List any issues this PR will resolve, e.g. Closes [...].

Version

List the OpenSearch version to which this PR applies, e.g. 2.14, 2.12--2.14, or all.

Frontend features

If you're submitting documentation for an OpenSearch Dashboards feature, add a video that shows how a user will interact with the UI step by step. A voiceover is optional.

Checklist

  • By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license and subject to the Developers Certificate of Origin.
    For more information on following Developer Certificate of Origin and signing off your commits, please check here.

Signed-off-by: George Chen <qchea@amazon.com>
@@ -62,6 +62,13 @@ When run, the `obfuscate` processor parses the fields into the following output:

Use the following configuration options with the `obfuscate` processor.

<!--
This table is auto generated.
Copy link
Member

Choose a reason for hiding this comment

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

Minor: "auto-generated"

<!--
This table is auto generated.
- name: obfuscate.
- pluginType: Processor.
Copy link
Member

Choose a reason for hiding this comment

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

Let's use lowercase "processor" to keep as a keyword.

This table is auto generated.
- name: obfuscate.
- pluginType: Processor.
- source: https://github.com/opensearch-project/data-prepper/blob/main/data-prepper-plugins/obfuscate-processor/src/main/java/org/opensearch/dataprepper/plugins/processor/obfuscation/ObfuscationProcessorConfig.java
Copy link
Member

Choose a reason for hiding this comment

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

It may be a good idea to use the commit in the URL rather than main. It will let us know the exact revision used.

Signed-off-by: George Chen <qchea@amazon.com>
Signed-off-by: George Chen <qchea@amazon.com>
@kolchfa-aws kolchfa-aws self-assigned this Jul 9, 2024
Co-authored-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com>
Signed-off-by: Qi Chen <chenqi0805@gmail.com>
Copy link
Member

@dlvenable dlvenable left a comment

Choose a reason for hiding this comment

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

Thanks @chenqi0805 !

@kolchfa-aws kolchfa-aws merged commit 3f3364a into opensearch-project:main Aug 15, 2024
7 checks passed
opensearch-trigger-bot bot pushed a commit that referenced this pull request Aug 15, 2024
…table (#7651)

* MAINT: add HTML comment

Signed-off-by: George Chen <qchea@amazon.com>

* MNT: address comments

Signed-off-by: George Chen <qchea@amazon.com>

* MAINT: period

Signed-off-by: George Chen <qchea@amazon.com>

* Update _data-prepper/pipelines/configuration/processors/obfuscate.md

Co-authored-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com>
Signed-off-by: Qi Chen <chenqi0805@gmail.com>

---------

Signed-off-by: George Chen <qchea@amazon.com>
Signed-off-by: Qi Chen <chenqi0805@gmail.com>
Co-authored-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com>
(cherry picked from commit 3f3364a)
Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants