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

Add Sycamore page #8234

Merged
merged 24 commits into from
Sep 16, 2024
Merged

Add Sycamore page #8234

merged 24 commits into from
Sep 16, 2024

Conversation

jonfritz
Copy link
Contributor

Description

This adds a page about using the open source Sycamore library for ETL into OpenSearch.

Issues Resolved

N/A

Version

2.9--2.16

Frontend features

N/A

Checklist

  • [X ] 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.

Create Sycamore page

Signed-off-by: jonfritz <[email protected]>
Add to docs

Signed-off-by: jonfritz <[email protected]>
Add info to docs page

Signed-off-by: jonfritz <[email protected]>
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.

@jonfritz
Copy link
Contributor Author

@kolchfa-aws thanks for helping! Please let me know if I need to assign anyone else.

@kolchfa-aws
Copy link
Collaborator

Thanks, @jonfritz! Could you also add Sycamore to the index page of the Tools section? https://opensearch.org/docs/latest/tools/

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.

Thank you, @jonfritz! Several suggestions for you.

_tools/sycamore.md Outdated Show resolved Hide resolved
_tools/sycamore.md Outdated Show resolved Hide resolved
_tools/sycamore.md Outdated Show resolved Hide resolved
_tools/sycamore.md Outdated Show resolved Hide resolved
_tools/sycamore.md Outdated Show resolved Hide resolved
_tools/sycamore.md Outdated Show resolved Hide resolved
_tools/sycamore.md Outdated Show resolved Hide resolved
_tools/sycamore.md Outdated Show resolved Hide resolved
_tools/sycamore.md Show resolved Hide resolved
_tools/sycamore.md Show resolved Hide resolved
jonfritz and others added 11 commits September 12, 2024 13:00
Co-authored-by: kolchfa-aws <[email protected]>
Signed-off-by: jonfritz <[email protected]>
Co-authored-by: kolchfa-aws <[email protected]>
Signed-off-by: jonfritz <[email protected]>
Co-authored-by: kolchfa-aws <[email protected]>
Signed-off-by: jonfritz <[email protected]>
Co-authored-by: kolchfa-aws <[email protected]>
Signed-off-by: jonfritz <[email protected]>
Co-authored-by: kolchfa-aws <[email protected]>
Signed-off-by: jonfritz <[email protected]>
Co-authored-by: kolchfa-aws <[email protected]>
Signed-off-by: jonfritz <[email protected]>
Co-authored-by: kolchfa-aws <[email protected]>
Signed-off-by: jonfritz <[email protected]>
Co-authored-by: kolchfa-aws <[email protected]>
Signed-off-by: jonfritz <[email protected]>
Co-authored-by: kolchfa-aws <[email protected]>
Signed-off-by: jonfritz <[email protected]>
Co-authored-by: kolchfa-aws <[email protected]>
Signed-off-by: jonfritz <[email protected]>
Correct typo

Signed-off-by: jonfritz <[email protected]>
@jonfritz
Copy link
Contributor Author

Updated and took the changes. Thanks for the review!

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.

Thanks! Looks like there are still a couple of outstanding suggestions. Also, please add Sycamore to the index page for the Tools section for findability. Thank you!

jonfritz and others added 6 commits September 12, 2024 13:31
Co-authored-by: kolchfa-aws <[email protected]>
Signed-off-by: jonfritz <[email protected]>
Co-authored-by: kolchfa-aws <[email protected]>
Signed-off-by: jonfritz <[email protected]>
Co-authored-by: kolchfa-aws <[email protected]>
Signed-off-by: jonfritz <[email protected]>
Co-authored-by: kolchfa-aws <[email protected]>
Signed-off-by: jonfritz <[email protected]>
Updates from suggestions

Signed-off-by: jonfritz <[email protected]>
Updating index with Sycamore

Signed-off-by: jonfritz <[email protected]>
@jonfritz
Copy link
Contributor Author

Sorry! Missed those suggestions, and now approved them. Also, added a note on index.md in the same pattern as the others. Thanks again!

_tools/index.md Outdated Show resolved Hide resolved
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.

@jonfritz @kolchfa-aws Please see my comments and changes and let me know if you have any questions. Thanks!

_tools/index.md Outdated Show resolved Hide resolved
_tools/sycamore.md Outdated Show resolved Hide resolved
_tools/sycamore.md Outdated Show resolved Hide resolved
_tools/sycamore.md Outdated Show resolved Hide resolved

* Read documents into a [DocSet](https://sycamore.readthedocs.io/en/stable/sycamore/get_started/concepts.html#docsets)
* [Partition documents](https://sycamore.readthedocs.io/en/stable/sycamore/transforms/partition.html) into structured JSON elements
* Extract metadata, filter and clean data using [transforms](https://sycamore.readthedocs.io/en/stable/sycamore/APIs/docset.html)
Copy link
Collaborator

Choose a reason for hiding this comment

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

Do we mean "Extract, filter, and clean metadata using transforms."? (add period)

_tools/sycamore.md Outdated Show resolved Hide resolved
_tools/sycamore.md Outdated Show resolved Hide resolved
_tools/sycamore.md Outdated Show resolved Hide resolved
_tools/sycamore.md Outdated Show resolved Hide resolved
_tools/sycamore.md Outdated Show resolved Hide resolved
_tools/sycamore.md Outdated Show resolved Hide resolved
Co-authored-by: Nathan Bower <[email protected]>
Signed-off-by: kolchfa-aws <[email protected]>
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.

LGTM. Thank you, @jonfritz!

@kolchfa-aws kolchfa-aws merged commit e0045f9 into opensearch-project:main Sep 16, 2024
6 checks passed
opensearch-trigger-bot bot pushed a commit that referenced this pull request Sep 16, 2024
* Create sycamore.md

Create Sycamore page

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

* Update sycamore.md

Add to docs

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

* Update sycamore.md

Add info to docs page

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

* Update _tools/sycamore.md

Co-authored-by: kolchfa-aws <[email protected]>
Signed-off-by: jonfritz <[email protected]>

* Update _tools/sycamore.md

Co-authored-by: kolchfa-aws <[email protected]>
Signed-off-by: jonfritz <[email protected]>

* Update _tools/sycamore.md

Co-authored-by: kolchfa-aws <[email protected]>
Signed-off-by: jonfritz <[email protected]>

* Update _tools/sycamore.md

Co-authored-by: kolchfa-aws <[email protected]>
Signed-off-by: jonfritz <[email protected]>

* Update _tools/sycamore.md

Co-authored-by: kolchfa-aws <[email protected]>
Signed-off-by: jonfritz <[email protected]>

* Update _tools/sycamore.md

Co-authored-by: kolchfa-aws <[email protected]>
Signed-off-by: jonfritz <[email protected]>

* Update _tools/sycamore.md

Co-authored-by: kolchfa-aws <[email protected]>
Signed-off-by: jonfritz <[email protected]>

* Update _tools/sycamore.md

Co-authored-by: kolchfa-aws <[email protected]>
Signed-off-by: jonfritz <[email protected]>

* Update _tools/sycamore.md

Co-authored-by: kolchfa-aws <[email protected]>
Signed-off-by: jonfritz <[email protected]>

* Update _tools/sycamore.md

Co-authored-by: kolchfa-aws <[email protected]>
Signed-off-by: jonfritz <[email protected]>

* Update sycamore.md

Correct typo

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

* Update _tools/sycamore.md

Co-authored-by: kolchfa-aws <[email protected]>
Signed-off-by: jonfritz <[email protected]>

* Update _tools/sycamore.md

Co-authored-by: kolchfa-aws <[email protected]>
Signed-off-by: jonfritz <[email protected]>

* Update _tools/sycamore.md

Co-authored-by: kolchfa-aws <[email protected]>
Signed-off-by: jonfritz <[email protected]>

* Update _tools/sycamore.md

Co-authored-by: kolchfa-aws <[email protected]>
Signed-off-by: jonfritz <[email protected]>

* Update sycamore.md

Updates from suggestions

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

* Update index.md

Updating index with Sycamore

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

* Update _tools/index.md

Signed-off-by: kolchfa-aws <[email protected]>

* Add front matter

Signed-off-by: Fanit Kolchina <[email protected]>

* Apply suggestions from code review

Co-authored-by: Nathan Bower <[email protected]>
Signed-off-by: kolchfa-aws <[email protected]>

---------

Signed-off-by: jonfritz <[email protected]>
Signed-off-by: kolchfa-aws <[email protected]>
Signed-off-by: Fanit Kolchina <[email protected]>
Co-authored-by: kolchfa-aws <[email protected]>
Co-authored-by: Fanit Kolchina <[email protected]>
Co-authored-by: Nathan Bower <[email protected]>
(cherry picked from commit e0045f9)
Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
github-actions bot pushed a commit that referenced this pull request Sep 16, 2024
noahstaveley pushed a commit to noahstaveley/documentation-website that referenced this pull request Sep 23, 2024
* Create sycamore.md

Create Sycamore page

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

* Update sycamore.md

Add to docs

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

* Update sycamore.md

Add info to docs page

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

* Update _tools/sycamore.md

Co-authored-by: kolchfa-aws <[email protected]>
Signed-off-by: jonfritz <[email protected]>

* Update _tools/sycamore.md

Co-authored-by: kolchfa-aws <[email protected]>
Signed-off-by: jonfritz <[email protected]>

* Update _tools/sycamore.md

Co-authored-by: kolchfa-aws <[email protected]>
Signed-off-by: jonfritz <[email protected]>

* Update _tools/sycamore.md

Co-authored-by: kolchfa-aws <[email protected]>
Signed-off-by: jonfritz <[email protected]>

* Update _tools/sycamore.md

Co-authored-by: kolchfa-aws <[email protected]>
Signed-off-by: jonfritz <[email protected]>

* Update _tools/sycamore.md

Co-authored-by: kolchfa-aws <[email protected]>
Signed-off-by: jonfritz <[email protected]>

* Update _tools/sycamore.md

Co-authored-by: kolchfa-aws <[email protected]>
Signed-off-by: jonfritz <[email protected]>

* Update _tools/sycamore.md

Co-authored-by: kolchfa-aws <[email protected]>
Signed-off-by: jonfritz <[email protected]>

* Update _tools/sycamore.md

Co-authored-by: kolchfa-aws <[email protected]>
Signed-off-by: jonfritz <[email protected]>

* Update _tools/sycamore.md

Co-authored-by: kolchfa-aws <[email protected]>
Signed-off-by: jonfritz <[email protected]>

* Update sycamore.md

Correct typo

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

* Update _tools/sycamore.md

Co-authored-by: kolchfa-aws <[email protected]>
Signed-off-by: jonfritz <[email protected]>

* Update _tools/sycamore.md

Co-authored-by: kolchfa-aws <[email protected]>
Signed-off-by: jonfritz <[email protected]>

* Update _tools/sycamore.md

Co-authored-by: kolchfa-aws <[email protected]>
Signed-off-by: jonfritz <[email protected]>

* Update _tools/sycamore.md

Co-authored-by: kolchfa-aws <[email protected]>
Signed-off-by: jonfritz <[email protected]>

* Update sycamore.md

Updates from suggestions

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

* Update index.md

Updating index with Sycamore

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

* Update _tools/index.md

Signed-off-by: kolchfa-aws <[email protected]>

* Add front matter

Signed-off-by: Fanit Kolchina <[email protected]>

* Apply suggestions from code review

Co-authored-by: Nathan Bower <[email protected]>
Signed-off-by: kolchfa-aws <[email protected]>

---------

Signed-off-by: jonfritz <[email protected]>
Signed-off-by: kolchfa-aws <[email protected]>
Signed-off-by: Fanit Kolchina <[email protected]>
Co-authored-by: kolchfa-aws <[email protected]>
Co-authored-by: Fanit Kolchina <[email protected]>
Co-authored-by: Nathan Bower <[email protected]>
Signed-off-by: Noah Staveley <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants