-
Notifications
You must be signed in to change notification settings - Fork 473
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
[Data Prepper] MAINT: add HTML comment on obfuscate processor config table #7651
Conversation
Signed-off-by: George Chen <[email protected]>
@@ -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. |
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.
Minor: "auto-generated"
<!-- | ||
This table is auto generated. | ||
- name: obfuscate. | ||
- pluginType: Processor. |
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 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 |
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.
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 <[email protected]>
Signed-off-by: George Chen <[email protected]>
Co-authored-by: kolchfa-aws <[email protected]> Signed-off-by: Qi Chen <[email protected]>
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.
Thanks @chenqi0805 !
…table (#7651) * MAINT: add HTML comment Signed-off-by: George Chen <[email protected]> * MNT: address comments Signed-off-by: George Chen <[email protected]> * MAINT: period Signed-off-by: George Chen <[email protected]> * Update _data-prepper/pipelines/configuration/processors/obfuscate.md Co-authored-by: kolchfa-aws <[email protected]> Signed-off-by: Qi Chen <[email protected]> --------- Signed-off-by: George Chen <[email protected]> Signed-off-by: Qi Chen <[email protected]> Co-authored-by: kolchfa-aws <[email protected]> (cherry picked from commit 3f3364a) Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
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
For more information on following Developer Certificate of Origin and signing off your commits, please check here.