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 new dot expander processor doc #5631

Merged
merged 37 commits into from
Jan 30, 2024
Merged

[DOC]Add new dot expander processor doc #5631

merged 37 commits into from
Jan 30, 2024

Conversation

vagimeli
Copy link
Collaborator

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
Copy link
Collaborator Author

vagimeli commented Nov 28, 2023

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

cc: @hdhalter for visibility

@vagimeli
Copy link
Collaborator Author

vagimeli commented Dec 1, 2023

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 vagimeli added the 3 - Tech review PR: Tech review in progress label Dec 5, 2023
@vagimeli
Copy link
Collaborator Author

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!

@vagimeli vagimeli added the Needs SME Waiting on input from subject matter expert label Dec 12, 2023
_ingest-pipelines/processors/dot-expander.md Outdated Show resolved Hide resolved
_ingest-pipelines/processors/dot-expander.md Outdated Show resolved Hide resolved
_ingest-pipelines/processors/dot-expander.md Outdated Show resolved Hide resolved
_ingest-pipelines/processors/dot-expander.md Outdated Show resolved Hide resolved
_ingest-pipelines/processors/dot-expander.md Outdated Show resolved Hide resolved
_ingest-pipelines/processors/dot-expander.md Outdated Show resolved Hide resolved
_ingest-pipelines/processors/dot-expander.md Show resolved Hide resolved
vagimeli and others added 3 commits December 21, 2023 16:06
Co-authored-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com>
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>
Co-authored-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com>
Signed-off-by: Melissa Vagi <vagimeli@amazon.com>
Copy link
Collaborator

@kolchfa-aws kolchfa-aws left a comment

Choose a reason for hiding this comment

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

Added examples of path parameter and field name conflicts.

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 comments and changes and let me know if you have any questions. Thanks!

_ingest-pipelines/processors/dot-expander.md Outdated Show resolved Hide resolved
_ingest-pipelines/processors/dot-expander.md Outdated Show resolved Hide resolved
_ingest-pipelines/processors/dot-expander.md Outdated Show resolved Hide resolved
_ingest-pipelines/processors/dot-expander.md Outdated Show resolved Hide resolved
_ingest-pipelines/processors/dot-expander.md Outdated Show resolved Hide resolved
```
{% include copy-curl.html %}

The response shows that the values were merged into an array:
Copy link
Collaborator

Choose a reason for hiding this comment

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

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

}
```

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:
Copy link
Collaborator

Choose a reason for hiding this comment

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

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

_ingest-pipelines/processors/dot-expander.md Outdated Show resolved Hide resolved
```
{% include copy-curl.html %}

Now simulate the pipeline:
Copy link
Collaborator

Choose a reason for hiding this comment

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

"Now you can simulate the pipeline"?

_ingest-pipelines/processors/dot-expander.md Outdated Show resolved Hide resolved
vagimeli and others added 13 commits January 18, 2024 11:47
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>
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>
@hdhalter hdhalter removed the Needs SME Waiting on input from subject matter expert label Jan 25, 2024
@vagimeli vagimeli added 5 - Editorial review PR: Editorial review in progress and removed 4 - Doc review PR: Doc review in progress labels Jan 25, 2024
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 Just one comment. Great job 😄

}
```

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:
Copy link
Collaborator

Choose a reason for hiding this comment

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

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

@vagimeli
Copy link
Collaborator Author

@vagimeli Just one comment. Great job 😄

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

@vagimeli vagimeli merged commit 8225f0b into main Jan 30, 2024
4 checks passed
@vagimeli vagimeli deleted the dot-expander.md branch January 30, 2024 17:57
@vagimeli vagimeli added backport 2.11 PR: Backport label for 2.11 and removed 5 - Editorial review PR: Editorial review in progress labels Jan 30, 2024
opensearch-trigger-bot bot pushed a commit that referenced this pull request Jan 30, 2024
* 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>
vagimeli pushed a commit that referenced this pull request Jan 30, 2024
* 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>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backport 2.11 PR: Backport label for 2.11 Content gap
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants