[DOC]Add new dot expander processor doc by vagimeli · Pull Request #5631 · opensearch-project/documentation-website

vagimeli · 2023-11-18T00:04:45Z

Description

Adds new dot expander processor documentation to address 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 · 2023-11-28T22:54:14Z

Hi @vamshin, Do we have a dev who can review this content for technical accuracy? Thanks, Melissa

cc: @hdhalter for visibility

vagimeli · 2023-12-01T19:55:22Z

Hi @macohen & @msfroh, Will you review, or direct me to the appropriate reviewer, for the ingest processor documentation? We're working through content gaps and need dev reviewers to vet technical accuracy. Thank you.

META issue for reference #4647

vagimeli · 2023-12-12T23:38:52Z

Hi @macohen & @msfroh, Will you review, or direct me to the appropriate reviewer, for the ingest processor documentation? We're working through content gaps and need dev reviewers to vet technical accuracy. Thank you.

META issue for reference #4647

@msfroh Do you have availability to review this PR? I don't want to dump all of the ingest processor reviews on you, so if there are other devs I can tag to share the review load, please let me know. Thank you!

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

Co-authored-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> Signed-off-by: Melissa Vagi <vagimeli@amazon.com>

kolchfa-aws

Added examples of path parameter and field name conflicts.

natebower

@vagimeli Please see my comments and changes and let me know if you have any questions. Thanks!

natebower · 2024-01-18T18:40:21Z

+```
+{% include copy-curl.html %}
+
+The response shows that the values were merged into an array:


"indicates" instead of "shows"? (optional suggestion)

natebower · 2024-01-18T18:41:54Z

+}
+```
+
+If there is a field name with a same name but a different path field needs to be renamed. For example, the following simulate call returns a parse exception:


"If a field contains the same name but a different path, then the field needs to be renamed"?

natebower · 2024-01-18T18:43:43Z

+```
+{% include copy-curl.html %}
+
+Now simulate the pipeline:


"Now you can simulate the pipeline"?

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

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

natebower

@vagimeli Just one comment. Great job 😄

natebower · 2024-01-26T12:41:39Z

+}
+```
+
+If a field contains the same name but a different path, then the field needs to be renamed. For example, the following simulate call returns a parse exception:


Should "simulate" be in code font (my brain wants to incorrectly change it to "simulated")?

vagimeli · 2024-01-30T17:53:41Z

@vagimeli Just one comment. Great job 😄

Thanks @natebower! I changed to _simulate because that's how it's used in the pipeline.

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

* Add new dot expander processor doc Signed-off-by: Melissa Vagi <vagimeli@amazon.com> * Draft content for tech review Signed-off-by: Melissa Vagi <vagimeli@amazon.com> * Address tech review feedback Signed-off-by: Melissa Vagi <vagimeli@amazon.com> * Update _ingest-pipelines/processors/dot-expander.md Co-authored-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> Signed-off-by: Melissa Vagi <vagimeli@amazon.com> * Update _ingest-pipelines/processors/dot-expander.md Co-authored-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> Signed-off-by: Melissa Vagi <vagimeli@amazon.com> * Update _ingest-pipelines/processors/dot-expander.md Co-authored-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> Signed-off-by: Melissa Vagi <vagimeli@amazon.com> * Update _ingest-pipelines/processors/dot-expander.md Co-authored-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> Signed-off-by: Melissa Vagi <vagimeli@amazon.com> * Address doc review feedback Signed-off-by: Melissa Vagi <vagimeli@amazon.com> * Edit line 227 Signed-off-by: Melissa Vagi <vagimeli@amazon.com> * Edit line 227 Signed-off-by: Melissa Vagi <vagimeli@amazon.com> * Edit line 227 Signed-off-by: Melissa Vagi <vagimeli@amazon.com> * Address doc review comments Signed-off-by: Melissa Vagi <vagimeli@amazon.com> * Update _ingest-pipelines/processors/dot-expander.md Co-authored-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com> Signed-off-by: Melissa Vagi <vagimeli@amazon.com> * Added path parameter and field name conflicts sections Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Update _ingest-pipelines/processors/dot-expander.md Co-authored-by: Nathan Bower <nbower@amazon.com> Signed-off-by: Melissa Vagi <vagimeli@amazon.com> * Update _ingest-pipelines/processors/dot-expander.md Co-authored-by: Nathan Bower <nbower@amazon.com> Signed-off-by: Melissa Vagi <vagimeli@amazon.com> * Update _ingest-pipelines/processors/dot-expander.md Co-authored-by: Nathan Bower <nbower@amazon.com> Signed-off-by: Melissa Vagi <vagimeli@amazon.com> * Update _ingest-pipelines/processors/dot-expander.md Co-authored-by: Nathan Bower <nbower@amazon.com> Signed-off-by: Melissa Vagi <vagimeli@amazon.com> * Update _ingest-pipelines/processors/dot-expander.md Co-authored-by: Nathan Bower <nbower@amazon.com> Signed-off-by: Melissa Vagi <vagimeli@amazon.com> * Update _ingest-pipelines/processors/dot-expander.md Co-authored-by: Nathan Bower <nbower@amazon.com> Signed-off-by: Melissa Vagi <vagimeli@amazon.com> * Update _ingest-pipelines/processors/dot-expander.md Co-authored-by: Nathan Bower <nbower@amazon.com> Signed-off-by: Melissa Vagi <vagimeli@amazon.com> * Update _ingest-pipelines/processors/dot-expander.md Co-authored-by: Nathan Bower <nbower@amazon.com> Signed-off-by: Melissa Vagi <vagimeli@amazon.com> * Update _ingest-pipelines/processors/dot-expander.md Co-authored-by: Nathan Bower <nbower@amazon.com> Signed-off-by: Melissa Vagi <vagimeli@amazon.com> * Update _ingest-pipelines/processors/dot-expander.md Co-authored-by: Nathan Bower <nbower@amazon.com> Signed-off-by: Melissa Vagi <vagimeli@amazon.com> * Address editorial review feedback Signed-off-by: Melissa Vagi <vagimeli@amazon.com> * Update dot-expander.md Signed-off-by: Melissa Vagi <vagimeli@amazon.com> --------- Signed-off-by: Melissa Vagi <vagimeli@amazon.com> Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> Co-authored-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> Co-authored-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com> Co-authored-by: Fanit Kolchina <kolchfa@amazon.com> Co-authored-by: Nathan Bower <nbower@amazon.com> (cherry picked from commit 8225f0b) Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>

* Add new dot expander processor doc * Draft content for tech review * Address tech review feedback * Update _ingest-pipelines/processors/dot-expander.md * Update _ingest-pipelines/processors/dot-expander.md * Update _ingest-pipelines/processors/dot-expander.md * Update _ingest-pipelines/processors/dot-expander.md * Address doc review feedback * Edit line 227 * Edit line 227 * Edit line 227 * Address doc review comments * Update _ingest-pipelines/processors/dot-expander.md * Added path parameter and field name conflicts sections * Update _ingest-pipelines/processors/dot-expander.md * Update _ingest-pipelines/processors/dot-expander.md * Update _ingest-pipelines/processors/dot-expander.md * Update _ingest-pipelines/processors/dot-expander.md * Update _ingest-pipelines/processors/dot-expander.md * Update _ingest-pipelines/processors/dot-expander.md * Update _ingest-pipelines/processors/dot-expander.md * Update _ingest-pipelines/processors/dot-expander.md * Update _ingest-pipelines/processors/dot-expander.md * Update _ingest-pipelines/processors/dot-expander.md * Address editorial review feedback * Update dot-expander.md --------- (cherry picked from commit 8225f0b) Signed-off-by: Melissa Vagi <vagimeli@amazon.com> Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com> Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com> Co-authored-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> Co-authored-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com> Co-authored-by: Fanit Kolchina <kolchfa@amazon.com> Co-authored-by: Nathan Bower <nbower@amazon.com>

Add new dot expander processor doc

1febfc9

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

vagimeli added the Content gap label Nov 18, 2023

vagimeli self-assigned this Nov 18, 2023

vagimeli requested review from AMoo-Miki, Naarcha-AWS, ananzh, hdhalter, kolchfa-aws, natebower and seanneumann as code owners November 18, 2023 00:04

vagimeli mentioned this pull request Nov 18, 2023

[META DOC] Ingest Processors Content Gaps #4647

Closed

45 tasks

vagimeli added 3 commits November 28, 2023 13:09

Merge branch 'main' into dot-expander.md

81eb142

Draft content for tech review

da2d4ad

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

Merge branch 'main' into dot-expander.md

e9b196f

Merge branch 'main' into dot-expander.md

793b2ba

vagimeli added the Tech review PR: Tech review in progress label Dec 5, 2023

Merge branch 'main' into dot-expander.md

7a7f886

vagimeli added the Needs SME label Dec 12, 2023

msfroh reviewed Dec 13, 2023

View reviewed changes

Comment thread _ingest-pipelines/processors/dot-expander.md

msfroh reviewed Dec 13, 2023

View reviewed changes

Comment thread _ingest-pipelines/processors/dot-expander.md Outdated

vagimeli added 3 commits December 21, 2023 14:25

Merge branch 'main' into dot-expander.md

4406af3

Address tech review feedback

3e977ff

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

Merge branch 'main' into dot-expander.md

8184c9e

Naarcha-AWS reviewed Dec 21, 2023

View reviewed changes

vagimeli and others added 3 commits December 21, 2023 16:06

Update _ingest-pipelines/processors/dot-expander.md

b3f912a

Co-authored-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> Signed-off-by: Melissa Vagi <vagimeli@amazon.com>

Update _ingest-pipelines/processors/dot-expander.md

5c85986

Co-authored-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> Signed-off-by: Melissa Vagi <vagimeli@amazon.com>

Update _ingest-pipelines/processors/dot-expander.md

64b1001

Co-authored-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> Signed-off-by: Melissa Vagi <vagimeli@amazon.com>

vagimeli requested a review from dlvenable as a code owner January 17, 2024 02:08

kolchfa-aws approved these changes Jan 17, 2024

View reviewed changes

natebower reviewed Jan 18, 2024

View reviewed changes

vagimeli and others added 13 commits January 18, 2024 11:47

Update _ingest-pipelines/processors/dot-expander.md

ec4477c

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

Update _ingest-pipelines/processors/dot-expander.md

dd9118a

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

Update _ingest-pipelines/processors/dot-expander.md

586f704

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

Update _ingest-pipelines/processors/dot-expander.md

29f3fb9

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

Update _ingest-pipelines/processors/dot-expander.md

026af45

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

Update _ingest-pipelines/processors/dot-expander.md

41dda97

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

Update _ingest-pipelines/processors/dot-expander.md

feae233

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

Update _ingest-pipelines/processors/dot-expander.md

53d0d0a

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

Update _ingest-pipelines/processors/dot-expander.md

3dde50b

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

Update _ingest-pipelines/processors/dot-expander.md

6a01fba

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

Address editorial review feedback

0d5c299

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

Merge branch 'main' into dot-expander.md

b201c63

Merge branch 'main' into dot-expander.md

fbb4146

hdhalter removed the Needs SME label Jan 25, 2024

vagimeli added 5 - Final Editorial Review and removed Doc review PR: Doc review in progress labels Jan 25, 2024

natebower reviewed Jan 26, 2024

View reviewed changes

vagimeli added 2 commits January 30, 2024 10:53

Merge branch 'main' into dot-expander.md

01d81b6

Update dot-expander.md

6729218

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

vagimeli merged commit 8225f0b into main Jan 30, 2024

vagimeli deleted the dot-expander.md branch January 30, 2024 17:57

vagimeli added backport 2.11 PR: Backport label for 2.11 and removed 5 - Final Editorial Review labels Jan 30, 2024

opensearch-trigger-bot Bot mentioned this pull request Jan 30, 2024

[Backport 2.11] [DOC]Add new dot expander processor doc #6299

Merged

Conversation

vagimeli commented Nov 18, 2023

Description

Issues Resolved

Checklist

Uh oh!

vagimeli commented Nov 28, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

vagimeli commented Dec 1, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

vagimeli commented Dec 12, 2023

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

kolchfa-aws left a comment

Choose a reason for hiding this comment

Uh oh!

natebower left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

natebower Jan 18, 2024

Choose a reason for hiding this comment

Uh oh!

natebower Jan 18, 2024

Choose a reason for hiding this comment

Uh oh!

Uh oh!

natebower Jan 18, 2024

Choose a reason for hiding this comment

Uh oh!

Uh oh!

natebower left a comment

Choose a reason for hiding this comment

Uh oh!

natebower Jan 26, 2024

Choose a reason for hiding this comment

Uh oh!

vagimeli commented Jan 30, 2024

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

vagimeli commented Nov 28, 2023 •

edited

Loading

vagimeli commented Dec 1, 2023 •

edited

Loading