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

Update expression and anomaly detector documentation #8041

Merged
merged 14 commits into from
Dec 3, 2024

Conversation

kkondaka
Copy link
Contributor

Description

Data Prepper supports arithmetic operators but the documentation is not updated to reflect that.
Also, Random Cut forest in anomaly detector processor support a new option which is not reflected in the documentation.

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.

Copy link

Thank you for submitting your PR. The PR states are In progress (or Draft) -> Tech review -> Doc review -> Editorial review -> Merged.

Before you submit your PR for doc review, make sure the content is technically accurate. If you need help finding a tech reviewer, tag a maintainer.

When you're ready for doc review, tag the assignee of this PR. The doc reviewer may push edits to the PR directly or leave comments and editorial suggestions for you to address (let us know in a comment if you have a preference). The doc reviewer will arrange for an editorial review.

_data-prepper/pipelines/expression-syntax.md Outdated Show resolved Hide resolved
_data-prepper/pipelines/expression-syntax.md Outdated Show resolved Hide resolved
_data-prepper/pipelines/expression-syntax.md Outdated Show resolved Hide resolved
_data-prepper/pipelines/expression-syntax.md Outdated Show resolved Hide resolved
_data-prepper/pipelines/expression-syntax.md Outdated Show resolved Hide resolved
@kolchfa-aws kolchfa-aws assigned vagimeli and unassigned kolchfa-aws Aug 16, 2024
vagimeli and others added 5 commits August 19, 2024 09:51
Co-authored-by: David Venable <[email protected]>
Signed-off-by: Melissa Vagi <[email protected]>
Co-authored-by: David Venable <[email protected]>
Signed-off-by: Melissa Vagi <[email protected]>
Co-authored-by: David Venable <[email protected]>
Signed-off-by: Melissa Vagi <[email protected]>
Co-authored-by: David Venable <[email protected]>
Signed-off-by: Melissa Vagi <[email protected]>
Co-authored-by: David Venable <[email protected]>
Signed-off-by: Melissa Vagi <[email protected]>
Copy link
Contributor

@vagimeli vagimeli left a comment

Choose a reason for hiding this comment

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

@kkondaka Doc review completed. Please see the writing edits for clarity and conciseness. Once these changes are approved, I'll move this PR into editorial and then merge it.

_data-prepper/pipelines/expression-syntax.md Outdated Show resolved Hide resolved
```
{% include copy-curl.html %}

The following are some example arithmetic expressions used in conditional expressions :
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
The following are some example arithmetic expressions used in conditional expressions :
The following are example arithmetic expressions that can be used in conditional expressions:

_data-prepper/pipelines/expression-syntax.md Outdated Show resolved Hide resolved
_data-prepper/pipelines/expression-syntax.md Outdated Show resolved Hide resolved
_data-prepper/pipelines/expression-syntax.md Outdated Show resolved Hide resolved
_data-prepper/pipelines/expression-syntax.md Outdated Show resolved Hide resolved
_data-prepper/pipelines/expression-syntax.md Outdated Show resolved Hide resolved
@vagimeli vagimeli added the 3 - Tech review PR: Tech review in progress label Aug 22, 2024
@vagimeli
Copy link
Contributor

@dlvenable I've completed the doc review and accepted your edits and comments. I also edited text for readability and style. Please review and approve at your availability, and then I'll move this forward for publishing. Thank you.

@vagimeli vagimeli added Needs SME Waiting on input from subject matter expert 3 - Tech review PR: Tech review in progress and removed 3 - Tech review PR: Tech review in progress labels Aug 29, 2024
@vagimeli vagimeli added data-prepper and removed 3 - Tech review PR: Tech review in progress labels Oct 9, 2024
@vagimeli
Copy link
Contributor

@dlvenable I've completed the doc review and accepted your edits and comments. I also edited text for readability and style. Please review and approve at your availability, and then I'll move this forward for publishing. Thank you.

@kkondaka @vagimeli Doc review is complete and ready for your approval. Thanks!

@vagimeli
Copy link
Contributor

vagimeli commented Nov 1, 2024

@dlvenable I've completed the doc review and accepted your edits and comments. I also edited text for readability and style. Please review and approve at your availability, and then I'll move this forward for publishing. Thank you.

@kkondaka @vagimeli Doc review is complete and ready for your approval. Thanks!

@kkondaka Please provide a status update for this PR. It's awaiting your acceptance of my doc review changes and @dlvenable approval. Thank you.

@vagimeli
Copy link
Contributor

@dlvenable I've completed the doc review and accepted your edits and comments. I also edited text for readability and style. Please review and approve at your availability, and then I'll move this forward for publishing. Thank you.

@kkondaka @vagimeli Doc review is complete and ready for your approval. Thanks!

@kkondaka Please provide a status update for this PR. It's awaiting your acceptance of my doc review changes and @dlvenable approval. Thank you.

@kkondaka @dlvenable Please provide a status update for this PR. It's awaiting your acceptance of my doc review changes and @dlvenable approval. Thank you.

@vagimeli vagimeli added the 3 - Tech review PR: Tech review in progress label Nov 13, 2024
@kolchfa-aws kolchfa-aws assigned Naarcha-AWS and unassigned vagimeli Dec 2, 2024
@Naarcha-AWS Naarcha-AWS requested a review from dlvenable December 3, 2024 16:00
@Naarcha-AWS Naarcha-AWS added backport 2.18 PR: Backport label for 2.18 and removed 3 - Tech review PR: Tech review in progress labels Dec 3, 2024
@Naarcha-AWS Naarcha-AWS dismissed dlvenable’s stale review December 3, 2024 16:00

Review feedback implemented

@Naarcha-AWS
Copy link
Collaborator

Reviewed this once again, looks like the original tech review by David was implemented. Dismissed his review and added Melissa's doc review. Merging now.

@Naarcha-AWS Naarcha-AWS merged commit 9bd4c42 into opensearch-project:main Dec 3, 2024
6 checks passed
opensearch-trigger-bot bot pushed a commit that referenced this pull request Dec 3, 2024
* Update expression and anomaly detector documentation

Signed-off-by: Kondaka <[email protected]>

* Update _data-prepper/pipelines/expression-syntax.md

Co-authored-by: David Venable <[email protected]>
Signed-off-by: Melissa Vagi <[email protected]>

* Update _data-prepper/pipelines/expression-syntax.md

Co-authored-by: David Venable <[email protected]>
Signed-off-by: Melissa Vagi <[email protected]>

* Update _data-prepper/pipelines/expression-syntax.md

Co-authored-by: David Venable <[email protected]>
Signed-off-by: Melissa Vagi <[email protected]>

* Update _data-prepper/pipelines/expression-syntax.md

Co-authored-by: David Venable <[email protected]>
Signed-off-by: Melissa Vagi <[email protected]>

* Update _data-prepper/pipelines/expression-syntax.md

Co-authored-by: David Venable <[email protected]>
Signed-off-by: Melissa Vagi <[email protected]>

* Apply suggestions from code review

Co-authored-by: Melissa Vagi <[email protected]>
Signed-off-by: Naarcha-AWS <[email protected]>

---------

Signed-off-by: Kondaka <[email protected]>
Signed-off-by: Melissa Vagi <[email protected]>
Signed-off-by: Naarcha-AWS <[email protected]>
Co-authored-by: Melissa Vagi <[email protected]>
Co-authored-by: David Venable <[email protected]>
Co-authored-by: Naarcha-AWS <[email protected]>
(cherry picked from commit 9bd4c42)
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
Labels
backport 2.18 PR: Backport label for 2.18 data-prepper Needs SME Waiting on input from subject matter expert
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants