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

[DOC] Add script processor documentation #5988

Merged
merged 17 commits into from
Jun 6, 2024
Merged

[DOC] Add script processor documentation #5988

merged 17 commits into from
Jun 6, 2024

Conversation

vagimeli
Copy link
Contributor

Description

Closes content gap

Issues Resolved

#4647

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: Melissa Vagi <vagimeli@amazon.com>
@vagimeli vagimeli added Needs SME Waiting on input from subject matter expert Content gap labels Dec 22, 2023
@vagimeli vagimeli self-assigned this Dec 22, 2023
@vagimeli
Copy link
Contributor Author

@hdhalter We need a dev to take the first pass at drafting this content. I can support them in refining the content and getting it through the documentation process. The ingest processor template is provided with this PR, so it should help the dev get started. Thanks!

@vagimeli vagimeli marked this pull request as draft February 15, 2024 21:21
@vagimeli vagimeli marked this pull request as ready for review May 28, 2024 19:56
vagimeli added 2 commits May 28, 2024 13:56
Signed-off-by: Melissa Vagi <vagimeli@amazon.com>
@vagimeli vagimeli added backport 2.14 PR: Backport label for 2.14 3 - Tech review PR: Tech review in progress and removed backport 2.14 PR: Backport label for 2.14 Needs SME Waiting on input from subject matter expert labels May 28, 2024
vagimeli added 3 commits May 30, 2024 10:07
Signed-off-by: Melissa Vagi <vagimeli@amazon.com>

Signed-off-by: Melissa Vagi <vagimeli@amazon.com>
@vagimeli
Copy link
Contributor Author

@gaobinlong This PR is ready for your technical review. Please review the pipeline examples closely, as I used Amazon Q to assist me in writing them. I tested using Dev Tools and didn't have issues. Thank you.

_ingest-pipelines/processors/script.md Outdated Show resolved Hide resolved
_ingest-pipelines/processors/script.md Outdated Show resolved Hide resolved
_ingest-pipelines/processors/script.md Show resolved Hide resolved
vagimeli added 2 commits June 5, 2024 15:22
Signed-off-by: Melissa Vagi <vagimeli@amazon.com>
vagimeli added 2 commits June 5, 2024 15:41
Signed-off-by: Melissa Vagi <vagimeli@amazon.com>
Signed-off-by: Melissa Vagi <vagimeli@amazon.com>
Copy link
Collaborator

@natebower natebower left a comment

Choose a reason for hiding this comment

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

@vagimeli Please see my comment (just one 😄) and changes and let me know if you have any questions. Thanks!

_ingest-pipelines/processors/script.md Outdated Show resolved Hide resolved
_ingest-pipelines/processors/script.md Outdated Show resolved Hide resolved
_ingest-pipelines/processors/script.md Outdated Show resolved Hide resolved
_ingest-pipelines/processors/script.md Outdated Show resolved Hide resolved
_ingest-pipelines/processors/script.md Outdated Show resolved Hide resolved

#### Response

This response confirms that the document is indexed into `testindex1` and is indexing all documents with the `message` field converted to uppercase.
Copy link
Collaborator

Choose a reason for hiding this comment

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

"is indexing" => either "has indexed" or "will index"

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Revised "has indexed"

vagimeli and others added 7 commits June 6, 2024 08:27
Co-authored-by: Nathan Bower <nbower@amazon.com>
Signed-off-by: Melissa Vagi <vagimeli@amazon.com>
Co-authored-by: Nathan Bower <nbower@amazon.com>
Signed-off-by: Melissa Vagi <vagimeli@amazon.com>
Co-authored-by: Nathan Bower <nbower@amazon.com>
Signed-off-by: Melissa Vagi <vagimeli@amazon.com>
Co-authored-by: Nathan Bower <nbower@amazon.com>
Signed-off-by: Melissa Vagi <vagimeli@amazon.com>
Co-authored-by: Nathan Bower <nbower@amazon.com>
Signed-off-by: Melissa Vagi <vagimeli@amazon.com>
Signed-off-by: Melissa Vagi <vagimeli@amazon.com>

Signed-off-by: Melissa Vagi <vagimeli@amazon.com>
@vagimeli
Copy link
Contributor Author

vagimeli commented Jun 6, 2024

@natebower Thank you for the thorough review. I accepted your edits and revised per your comment. Will you approve for merging? Thank you.

Copy link
Collaborator

@natebower natebower left a comment

Choose a reason for hiding this comment

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

LGTM

@vagimeli vagimeli merged commit ce41cdf into main Jun 6, 2024
8 checks passed
@vagimeli vagimeli deleted the script-processor branch June 6, 2024 14:59
opensearch-trigger-bot bot pushed a commit that referenced this pull request Jun 6, 2024
* Add script processor documentation

Signed-off-by: Melissa Vagi <vagimeli@amazon.com>

* add text adn query examples

Signed-off-by: Melissa Vagi <vagimeli@amazon.com>

* Update script.md

Signed-off-by: Melissa Vagi <vagimeli@amazon.com>

Signed-off-by: Melissa Vagi <vagimeli@amazon.com>

* Address tech review comments

Signed-off-by: Melissa Vagi <vagimeli@amazon.com>

* Address tech review comments

Signed-off-by: Melissa Vagi <vagimeli@amazon.com>

* Address tech review comments

Signed-off-by: Melissa Vagi <vagimeli@amazon.com>

* Update _ingest-pipelines/processors/script.md

Co-authored-by: Nathan Bower <nbower@amazon.com>
Signed-off-by: Melissa Vagi <vagimeli@amazon.com>

* Update _ingest-pipelines/processors/script.md

Co-authored-by: Nathan Bower <nbower@amazon.com>
Signed-off-by: Melissa Vagi <vagimeli@amazon.com>

* Update _ingest-pipelines/processors/script.md

Co-authored-by: Nathan Bower <nbower@amazon.com>
Signed-off-by: Melissa Vagi <vagimeli@amazon.com>

* Update _ingest-pipelines/processors/script.md

Co-authored-by: Nathan Bower <nbower@amazon.com>
Signed-off-by: Melissa Vagi <vagimeli@amazon.com>

* Update _ingest-pipelines/processors/script.md

Co-authored-by: Nathan Bower <nbower@amazon.com>
Signed-off-by: Melissa Vagi <vagimeli@amazon.com>

* Update script.md

Signed-off-by: Melissa Vagi <vagimeli@amazon.com>

Signed-off-by: Melissa Vagi <vagimeli@amazon.com>

---------

Signed-off-by: Melissa Vagi <vagimeli@amazon.com>
Co-authored-by: Nathan Bower <nbower@amazon.com>
(cherry picked from commit ce41cdf)
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
3 - Tech review PR: Tech review in progress backport 2.14 PR: Backport label for 2.14 Content gap
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants