Skip to content

[Phase 1] Rework Data Prepper section #9976

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

Open
wants to merge 6 commits into
base: main
Choose a base branch
from

Conversation

Naarcha-AWS
Copy link
Collaborator

Description

This PR acts as a proposal for updating the Data Prepper IA to achieve the same standard as Benchmark and VectorSearch. To do so, it takes the following actions:

  • Breaking up Getting Started into its own section so we can additional installation and configuration instructions.
  • Add additional sections (Advanced Configurations and Techniques) to Managing Data Prepper to make it easier to navigate.
  • Add cards for each configuration to Pipeline intro page.
  • Place Pipeline functions into their own folder for easier contribution.

It would be good to have an intro video on the main page, similar to VectorSearch.

Issues Resolved

Closes #[delete this text, including the brackets, and replace with the issue number]

Version

List the OpenSearch version to which this PR applies, e.g. 2.14, 2.12--2.14, or all.

Frontend features

If you're submitting documentation for an OpenSearch Dashboards feature, add a video that shows how a user will interact with the UI step by step. A voiceover is optional.

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: Nate Archer <[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.

@Naarcha-AWS
Copy link
Collaborator Author

This current draft doesn't do the work of adding the cards quite yet. For your review, I put comments where I plan on placing cards, as well as what additional tweaks I plan to make so I can get them started when I return from vacation.

Still to do:

  • Add additional context to installation page, suggest alternative container applications to Docker.
  • Streamline and improve any pipeline related content so it doesn't repeat multiple times.
  • Add additional configuration options.
  • Find a home for Core APIs.

@Naarcha-AWS
Copy link
Collaborator Author

@kolchfa-aws: Here's what I have so far. Feel free to offer some suggestions.

Signed-off-by: Archer <[email protected]>
Signed-off-by: Archer <[email protected]>
@Naarcha-AWS Naarcha-AWS marked this pull request as ready for review June 19, 2025 18:45
@Naarcha-AWS Naarcha-AWS changed the title [Draft] Rework Data Prepper section [Phase 1] Rework Data Prepper section Jun 19, 2025
@Naarcha-AWS Naarcha-AWS added 3 - Tech review PR: Tech review in progress backport 3.0 labels Jun 19, 2025
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 3.0
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant