[DOC] Add html strip processor documentation #5984
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Signed-off-by: Melissa Vagi <vagimeli@amazon.com>
vagimeli
added
Needs SME
vagimeli
requested review from
hdhalter,
kolchfa-aws,
Naarcha-AWS,
AMoo-Miki and
natebower
as code owners
|
@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! |
Signed-off-by: Melissa Vagi <vagimeli@amazon.com>
45 tasks
vagimeli
requested review from
dlvenable,
stephen-crawford and
epugh
as code owners
Signed-off-by: Melissa Vagi <vagimeli@amazon.com>
|
@gaobinlong This PR is ready for technical review. Thank you! |
vagimeli
added
3 - Tech review
gaobinlong
reviewed
May 31, 2024
Signed-off-by: Melissa Vagi <vagimeli@amazon.com>
vagimeli
added
5 - Editorial review
natebower
reviewed
Jun 6, 2024
|
|
||
| # HTML strip processor | ||
|
|
||
| The `html_strip` processor removes HTML tags from string fields in incoming documents. The processor is useful when indexing data from web pages or other sources that may contain HTML markup. By removing the HTML tags, you can ensure that the indexed content is clean and easily searchable. HTML tags are replaced with newline characters (`\n`). |
There was a problem hiding this comment.
Can we be more precise than "clean"? What do we actually mean by this?
There was a problem hiding this comment.
Deleted that sentence. It's not necessary info. "Clean" means readable text content without HTML tags.
|
|
||
| #### Response | ||
|
|
||
| The response shows that the request has indexed the document into the index `products` and will index all documents with the `description` field containing HTML tags, while storing the cleaned version in the `cleaned_description` field. |
There was a problem hiding this comment.
Same comment re: "clean"
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>
vagimeli
commented
Jun 6, 2024
Signed-off-by: Melissa Vagi <vagimeli@amazon.com>
vagimeli
commented
Jun 6, 2024
Signed-off-by: Melissa Vagi <vagimeli@amazon.com>
vagimeli
commented
Jun 6, 2024
Signed-off-by: Melissa Vagi <vagimeli@amazon.com>
vagimeli
commented
Jun 6, 2024
Signed-off-by: Melissa Vagi <vagimeli@amazon.com>
opensearch-trigger-bot bot
pushed a commit
that referenced
this pull request
Jun 6, 2024
* Add html strip processor documentation Signed-off-by: Melissa Vagi <vagimeli@amazon.com> * Add html strip processor documentation Signed-off-by: Melissa Vagi <vagimeli@amazon.com> * Add examples Signed-off-by: Melissa Vagi <vagimeli@amazon.com> * Copy edits Signed-off-by: Melissa Vagi <vagimeli@amazon.com> * Update _ingest-pipelines/processors/html-strip.md Co-authored-by: Nathan Bower <nbower@amazon.com> Signed-off-by: Melissa Vagi <vagimeli@amazon.com> * Update _ingest-pipelines/processors/html-strip.md Co-authored-by: Nathan Bower <nbower@amazon.com> Signed-off-by: Melissa Vagi <vagimeli@amazon.com> * Update _ingest-pipelines/processors/html-strip.md Co-authored-by: Nathan Bower <nbower@amazon.com> Signed-off-by: Melissa Vagi <vagimeli@amazon.com> * Update _ingest-pipelines/processors/html-strip.md Co-authored-by: Nathan Bower <nbower@amazon.com> Signed-off-by: Melissa Vagi <vagimeli@amazon.com> * Update _ingest-pipelines/processors/html-strip.md Signed-off-by: Melissa Vagi <vagimeli@amazon.com> * Update _ingest-pipelines/processors/html-strip.md Signed-off-by: Melissa Vagi <vagimeli@amazon.com> * Update _ingest-pipelines/processors/html-strip.md Signed-off-by: Melissa Vagi <vagimeli@amazon.com> * Update _ingest-pipelines/processors/html-strip.md 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 6a119e1) 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
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
Closes content gap
Issues Resolved
#4647
Checklist
For more information on following Developer Certificate of Origin and signing off your commits, please check here.