Getting started data prepper #1480

carolxob · 2022-10-07T19:22:47Z

Description

Merged content from Data Prepper repo documentation into existing page on OpenSearch documentation website.

Issues Resolved

Fixes #1457

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.

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

This reverts commit 48a9fb5.

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

carolxob · 2022-10-07T19:23:56Z

@dlvenable This is ready for your review.

dlvenable

Thanks for making these improvements to the opensearch.org documentation!

_clients/data-prepper/get-started.md

dlvenable · 2022-10-07T19:53:04Z

_clients/data-prepper/get-started.md

+There are two ways to install Data Prepper for running:
+
+1. Run the Docker image
+2. Build from source


It is possible to install from tar.gz now. (Our repo is out-of-date on this).

I'm not sure we want to have "Build from source" in the opensearch.org documentation. It is mostly useful in certain situations (bleeding-edge, contributions).

@dlvenable Do you have a link to the tar.gz file?

The tar.gz changes with every build. I think the best solution is to point the customer to the download page: https://opensearch.org/downloads.html#data-prepper

That will have the latest version available.

@Naarcha-AWS FYI, there is some new information here.

@dlvenable Noted - I am going to make a separate issue to address the tar.gz installation instructions.

_clients/data-prepper/get-started.md

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

Co-authored-by: Naarcha-AWS <[email protected]>

dlvenable

Some of the URLs will still be dead links as the content has not been copied over.

The full list of available pages is found here:

https://github.com/opensearch-project/documentation-website/tree/main/_clients/data-prepper

You can see that pages like trace-analytics or migrate-open-distro are not present.

Those files are available in Data Prepper documentation and you can see there all at the following link:

https://github.com/opensearch-project/data-prepper/tree/main/docs

dlvenable

I still believe there are broken links.

_clients/data-prepper/get-started.md

natebower

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

_clients/data-prepper/get-started.md

Co-authored-by: Nate Bower <[email protected]>

Fixes merged conflicts from PR #1480

* Update data prepper get started.md Fixes merged conflicts from PR #1480 * Update _data-prepper/get-started.md Co-authored-by: Naarcha-AWS <[email protected]> * Update _data-prepper/get-started.md Co-authored-by: Naarcha-AWS <[email protected]> * Update _data-prepper/get-started.md Co-authored-by: Naarcha-AWS <[email protected]> * Update _data-prepper/get-started.md Co-authored-by: Naarcha-AWS <[email protected]> * Update _data-prepper/get-started.md Co-authored-by: Naarcha-AWS <[email protected]> * Update _data-prepper/get-started.md Co-authored-by: Naarcha-AWS <[email protected]> Co-authored-by: Naarcha-AWS <[email protected]>

* Update data prepper get started.md Fixes merged conflicts from PR #1480 * Update _data-prepper/get-started.md Co-authored-by: Naarcha-AWS <[email protected]> * Update _data-prepper/get-started.md Co-authored-by: Naarcha-AWS <[email protected]> * Update _data-prepper/get-started.md Co-authored-by: Naarcha-AWS <[email protected]> * Update _data-prepper/get-started.md Co-authored-by: Naarcha-AWS <[email protected]> * Update _data-prepper/get-started.md Co-authored-by: Naarcha-AWS <[email protected]> * Update _data-prepper/get-started.md Co-authored-by: Naarcha-AWS <[email protected]> Co-authored-by: Naarcha-AWS <[email protected]> (cherry picked from commit 360e659)

* Update data prepper get started.md Fixes merged conflicts from PR #1480 * Update _data-prepper/get-started.md Co-authored-by: Naarcha-AWS <[email protected]> * Update _data-prepper/get-started.md Co-authored-by: Naarcha-AWS <[email protected]> * Update _data-prepper/get-started.md Co-authored-by: Naarcha-AWS <[email protected]> * Update _data-prepper/get-started.md Co-authored-by: Naarcha-AWS <[email protected]> * Update _data-prepper/get-started.md Co-authored-by: Naarcha-AWS <[email protected]> * Update _data-prepper/get-started.md Co-authored-by: Naarcha-AWS <[email protected]> Co-authored-by: Naarcha-AWS <[email protected]> (cherry picked from commit 360e659) Co-authored-by: Caroline <[email protected]>

carolxob added 3 commits October 4, 2022 13:06

Added cluster permissions to cluster permissions list.

e896071

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

Revert "Added cluster permissions to cluster permissions list."

12edb4a

This reverts commit 48a9fb5.

Merged data prepper git started content

d118fd6

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

carolxob added 2 - In progress Issue/PR: The issue or PR is in progress. backport 2.0 PR: Backport label for v2.0.x backport 2.1 PR: Backport label for 2.1 backport 2.2 PR: Backport label for 2.2 backport 2.3 PR: Backport label for 2.3 labels Oct 7, 2022

carolxob self-assigned this Oct 7, 2022

carolxob requested a review from a team as a code owner October 7, 2022 19:22

carolxob added 3 - Tech review PR: Tech review in progress and removed 2 - In progress Issue/PR: The issue or PR is in progress. labels Oct 7, 2022

dlvenable requested changes Oct 7, 2022

View reviewed changes

carolxob added the data-prepper label Oct 7, 2022

Naarcha-AWS reviewed Oct 10, 2022

View reviewed changes

_clients/data-prepper/get-started.md Outdated Show resolved Hide resolved

Naarcha-AWS reviewed Oct 10, 2022

View reviewed changes

_clients/data-prepper/get-started.md Outdated Show resolved Hide resolved

Naarcha-AWS reviewed Oct 10, 2022

View reviewed changes

_clients/data-prepper/get-started.md Outdated Show resolved Hide resolved

carolxob and others added 2 commits October 10, 2022 15:34

Added review feedback.

0269b9e

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

Apply suggestions from code review

1efda4e

Co-authored-by: Naarcha-AWS <[email protected]>

carolxob requested review from Naarcha-AWS and dlvenable October 10, 2022 21:36

dlvenable requested changes Oct 11, 2022

View reviewed changes

Naarcha-AWS added 5 - Editorial review PR: Editorial review in progress and removed 3 - Tech review PR: Tech review in progress labels Nov 2, 2022

Naarcha-AWS approved these changes Nov 4, 2022

View reviewed changes

dlvenable requested changes Nov 4, 2022

View reviewed changes

_clients/data-prepper/get-started.md Show resolved Hide resolved

_clients/data-prepper/get-started.md Outdated Show resolved Hide resolved

natebower reviewed Nov 7, 2022

View reviewed changes

natebower removed the 5 - Editorial review PR: Editorial review in progress label Nov 7, 2022

carolxob commented Nov 7, 2022

View reviewed changes

_clients/data-prepper/get-started.md Outdated Show resolved Hide resolved

carolxob and others added 16 commits November 8, 2022 10:43

Update _clients/data-prepper/get-started.md

bb43259

Co-authored-by: Nate Bower <[email protected]>

Update _clients/data-prepper/get-started.md

25ecd54

Update _clients/data-prepper/get-started.md

8c39d43

Co-authored-by: Nate Bower <[email protected]>

Update _clients/data-prepper/get-started.md

1053971

Co-authored-by: Nate Bower <[email protected]>

Update _clients/data-prepper/get-started.md

4bab8e5

Co-authored-by: Nate Bower <[email protected]>

Update _clients/data-prepper/get-started.md

32b8951

Update _clients/data-prepper/get-started.md

5b8a566

Co-authored-by: Nate Bower <[email protected]>

Update _clients/data-prepper/get-started.md

b82397e

Update _clients/data-prepper/get-started.md

7839247

Co-authored-by: Nate Bower <[email protected]>

Update _clients/data-prepper/get-started.md

67115b5

Co-authored-by: Nate Bower <[email protected]>

Update _clients/data-prepper/get-started.md

597ed55

Co-authored-by: Nate Bower <[email protected]>

Update _clients/data-prepper/get-started.md

1039837

Co-authored-by: Nate Bower <[email protected]>

Update _clients/data-prepper/get-started.md

42b4bb2

Co-authored-by: Nate Bower <[email protected]>

Update _clients/data-prepper/get-started.md

60fa7e1

Co-authored-by: Nate Bower <[email protected]>

Update _clients/data-prepper/get-started.md

a72627a

Co-authored-by: Nate Bower <[email protected]>

Update _clients/data-prepper/get-started.md

3f8fd64

Co-authored-by: Nate Bower <[email protected]>

carolxob added a commit that referenced this pull request Nov 8, 2022

Update data prepper get started.md

276ecdc

Fixes merged conflicts from PR #1480

carolxob mentioned this pull request Nov 8, 2022

Update data prepper get started.md #1839

Merged

1 task

Naarcha-AWS closed this Nov 8, 2022

Naarcha-AWS deleted the getting-started-data-prepper branch November 8, 2022 21:43

carolxob mentioned this pull request Nov 16, 2022

[DOC-META] Migrate Data Prepper documentation #1267

Closed

19 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Getting started data prepper #1480

Getting started data prepper #1480

carolxob commented Oct 7, 2022

carolxob commented Oct 7, 2022

dlvenable left a comment

dlvenable Oct 7, 2022

carolxob Oct 10, 2022

dlvenable Oct 11, 2022

carolxob Oct 12, 2022

carolxob Nov 3, 2022

dlvenable left a comment

dlvenable left a comment

natebower left a comment

Getting started data prepper #1480

Getting started data prepper #1480

Conversation

carolxob commented Oct 7, 2022

Description

Issues Resolved

Checklist

carolxob commented Oct 7, 2022

dlvenable left a comment

Choose a reason for hiding this comment

dlvenable Oct 7, 2022

Choose a reason for hiding this comment

carolxob Oct 10, 2022

Choose a reason for hiding this comment

dlvenable Oct 11, 2022

Choose a reason for hiding this comment

carolxob Oct 12, 2022

Choose a reason for hiding this comment

carolxob Nov 3, 2022

Choose a reason for hiding this comment

dlvenable left a comment

Choose a reason for hiding this comment

dlvenable left a comment

Choose a reason for hiding this comment

natebower left a comment

Choose a reason for hiding this comment