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.

Sign up for GitHub

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

Jump to bottom

Minor changes to Data Prepper index.md. #2426

Merged
merged 11 commits into from
Jan 23, 2023
Merged

Minor changes to Data Prepper index.md. #2426

merged 11 commits into from
Jan 23, 2023

Conversation

carolxob
Copy link
Contributor

@carolxob carolxob commented Jan 18, 2023 •
edited
Loading

Signed-off-by: carolxob carolxob@amazon.com

Description

This change addresses minor fixes, like typos or spacing issues on some of the main pages for Data Prepper documentation. Also addresses Data Prepper navigation/ToC.

Issues Resolved

There are currently no issues associated with this PR.

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.

@carolxob
Minor changes to index.md.
6c305d9 
Signed-off-by: carolxob <carolxob@amazon.com>
@carolxob carolxob added 2 - In progress Issue/PR: The issue or PR is in progress. data-prepper labels Jan 18, 2023
@carolxob carolxob requested a review from a team as a code owner January 18, 2023 20:18
@carolxob carolxob self-assigned this Jan 18, 2023
@carolxob carolxob changed the title Minor changes to index.md. Minor changes to Data Prepper index.md. Jan 18, 2023
@carolxob
Minor typo/formatting fixes.
9d4166a 
Signed-off-by: carolxob <carolxob@amazon.com>
@carolxob
Minor change.
333130d 
Signed-off-by: carolxob <carolxob@amazon.com>
@carolxob
Adjusted ToC order so that Getting started appears before Core APIs.
31a4598 
Signed-off-by: carolxob <carolxob@amazon.com>
@carolxob
Copy link
Contributor Author

carolxob commented Jan 20, 2023 •
edited
Loading

Existing ToC:

Data Prepper

  • Getting started
  • Log4j configuration
  • Configure Logstash for Data Prepper
  • Pipelines
  • Log analytics
  • Core APIs
  • Migrating from Open Distro Data Prepper

Proposed re-ordering of overall ToC from @dlvenable:

Data Prepper

  • Getting started
  • Pipelines
  • Log analytics
  • Core APIs
  • Configuring Log4j
  • Migrating from Logstash
  • Migrating from Open Distro Data Prepper

Future proposed ToC: (#2453)

Data Prepper
Getting started
Using for common scenarios

  • Trace analytics
  • Log analytics
    Authoring Pipelines (could be Configuration Data Prepper)
  • Pipeline options
  • Expression syntax
  • Sources
  • Buffers
  • Processors
  • Sinks
    Administrating Data Prepper
  • Core APIs
  • Log4j Configuration
  • Data Prepper Configuration (not yet present)
  • Peer Forwarder (not yet present)
    Migrating from Logstash
    Migrating from Open Distro Data Prepper

@carolxob
Minor edits to titles.
1f76123 
Signed-off-by: carolxob <carolxob@amazon.com>
@carolxob
Minor adjustments to ToC.
986a996 
Signed-off-by: carolxob <carolxob@amazon.com>
@carolxob
Changed filename.
6fa800c 
Signed-off-by: carolxob <carolxob@amazon.com>
@carolxob
Minor ToC edit
4202ac2 
Signed-off-by: carolxob <carolxob@amazon.com>
@carolxob carolxob added 4 - Doc review PR: Doc review in progress and removed 2 - In progress Issue/PR: The issue or PR is in progress. labels Jan 21, 2023
@carolxob
Minor edits.
9f7c9c6 
Signed-off-by: carolxob <carolxob@amazon.com>
alicejw1
alicejw1 approved these changes Jan 21, 2023
View reviewed changes
Copy link
Contributor

@alicejw1 alicejw1 left a comment

Choose a reason for hiding this comment

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

Looks good!

cwillum
cwillum approved these changes Jan 21, 2023
View reviewed changes
Copy link
Contributor

@cwillum cwillum left a comment

Choose a reason for hiding this comment

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

LGTM

@dlvenable
Copy link
Member

I put together #2453 to propose a possible ToC structure. I'd be happy to have a discussion on the approach in that issue.

natebower
natebower reviewed Jan 23, 2023
View reviewed changes
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.

@carolxob Just a few minor changes. Thanks!

_data-prepper/getting-started.md Outdated Show resolved Hide resolved
_data-prepper/index.md Outdated Show resolved Hide resolved
@carolxob
Minor edit.
141a2dc 
Signed-off-by: carolxob <carolxob@amazon.com>
@carolxob
Edits made based on editorial feedback.
3a5ad86 
Signed-off-by: carolxob <carolxob@amazon.com>
@carolxob carolxob added 5 - Editorial review PR: Editorial review in progress 6 - Done but waiting to merge PR: The work is done and ready to merge and removed 4 - Doc review PR: Doc review in progress 5 - Editorial review PR: Editorial review in progress labels Jan 23, 2023
@hdhalter
Copy link
Contributor

HI @carolxob - why are you waiting to merge this? Isn't this going in the 2.5 build? Thx.

@carolxob
Copy link
Contributor Author

@hdhalter Only applied this label in case we needed to wait to merge. It is otherwise ready to go.

@carolxob carolxob removed the 6 - Done but waiting to merge PR: The work is done and ready to merge label Jan 23, 2023
@carolxob carolxob added the 4 - Doc review PR: Doc review in progress label Jan 23, 2023
@carolxob carolxob merged commit 80aaf54 into main Jan 23, 2023
vagimeli pushed a commit that referenced this pull request Jan 25, 2023
@carolxob @vagimeli
Minor changes to Data Prepper index.md. (#2426)
9ca2980 
* Minor changes to index.md.

Signed-off-by: carolxob <carolxob@amazon.com>

* Minor typo/formatting fixes.

Signed-off-by: carolxob <carolxob@amazon.com>

* Minor change.

Signed-off-by: carolxob <carolxob@amazon.com>

* Adjusted ToC order so that Getting started appears before Core APIs.

Signed-off-by: carolxob <carolxob@amazon.com>

* Minor edits to titles.

Signed-off-by: carolxob <carolxob@amazon.com>

* Minor adjustments to ToC.

Signed-off-by: carolxob <carolxob@amazon.com>

* Changed filename.

Signed-off-by: carolxob <carolxob@amazon.com>

* Minor ToC edit

Signed-off-by: carolxob <carolxob@amazon.com>

* Minor edits.

Signed-off-by: carolxob <carolxob@amazon.com>

* Minor edit.

Signed-off-by: carolxob <carolxob@amazon.com>

* Edits made based on editorial feedback.

Signed-off-by: carolxob <carolxob@amazon.com>

Signed-off-by: carolxob <carolxob@amazon.com>
vagimeli added a commit that referenced this pull request Jan 26, 2023
@vagimeli
Revert "Minor changes to Data Prepper index.md. (#2426)"
97aaf3f 
This reverts commit 9ca2980.
vagimeli pushed a commit that referenced this pull request Jan 27, 2023
@carolxob @vagimeli
Minor changes to Data Prepper index.md. (#2426)
787fc76 
* Minor changes to index.md.

Signed-off-by: carolxob <carolxob@amazon.com>

* Minor typo/formatting fixes.

Signed-off-by: carolxob <carolxob@amazon.com>

* Minor change.

Signed-off-by: carolxob <carolxob@amazon.com>

* Adjusted ToC order so that Getting started appears before Core APIs.

Signed-off-by: carolxob <carolxob@amazon.com>

* Minor edits to titles.

Signed-off-by: carolxob <carolxob@amazon.com>

* Minor adjustments to ToC.

Signed-off-by: carolxob <carolxob@amazon.com>

* Changed filename.

Signed-off-by: carolxob <carolxob@amazon.com>

* Minor ToC edit

Signed-off-by: carolxob <carolxob@amazon.com>

* Minor edits.

Signed-off-by: carolxob <carolxob@amazon.com>

* Minor edit.

Signed-off-by: carolxob <carolxob@amazon.com>

* Edits made based on editorial feedback.

Signed-off-by: carolxob <carolxob@amazon.com>

Signed-off-by: carolxob <carolxob@amazon.com>
vagimeli added a commit that referenced this pull request Jan 30, 2023
@vagimeli
Revert "Minor changes to Data Prepper index.md. (#2426)"
4c33af8 
This reverts commit 787fc76.
@hdhalter hdhalter deleted the main-page-fixes branch March 28, 2024 21:42
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@cwillum cwillum cwillum approved these changes

@alicejw1 alicejw1 alicejw1 approved these changes

@natebower natebower Awaiting requested review from natebower natebower is a code owner

@Naarcha-AWS Naarcha-AWS Awaiting requested review from Naarcha-AWS Naarcha-AWS is a code owner

Assignees

@carolxob carolxob

Labels
4 - Doc review PR: Doc review in progress data-prepper
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
6 participants
@carolxob @dlvenable @hdhalter @alicejw1 @natebower @cwillum