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

MAINT: documentation update for certain processors #7713

Conversation

chenqi0805
Copy link
Contributor

Description

This PR

  • corrects uri path with plugin name
  • corrects misses in documentation
  • adds HTML comments on config table for auto-generation

Issues Resolved

List any issues this PR will resolve, e.g. Closes [...].

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: George Chen <qchea@amazon.com>
@chenqi0805 chenqi0805 marked this pull request as ready for review July 15, 2024 18:49
@chenqi0805 chenqi0805 changed the title MAINT: documentation update for processors MAINT: documentation update for certain processors Jul 15, 2024
@@ -1,6 +1,6 @@
---
layout: default
title: otel_trace
title: otel_traces
Copy link
Member

Choose a reason for hiding this comment

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

We should probably clarify somewhere that otel_trace was the old name.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Our deprecated name was otel_trace_raw. I never saw otel_trace anywhere in our repo

@vagimeli
Copy link
Collaborator

@hdhalter We need to resolve the broken links problem across these Data Prepper PRs. See blocking PR comment in #7707

@dlvenable
Copy link
Member

@chenqi0805 , There are two things you need to do to get this PR ready:

  1. Rebase from main. In Adds documentation for the Data Prepper delay processor. #7708, I renamed this processor already. You might not even need any changes to this file.
  2. You renamed a few other processors. There are links to these processors in other pages and those links are broken. You can see the Jekyll report for more information: https://github.com/opensearch-project/documentation-website/actions/runs/9978970672/job/27577051304?pr=7713. Also, I did something similar in Adds documentation for the Data Prepper delay processor. #7708 for delete_entries. You can look there and see an example.

Signed-off-by: George Chen <qchea@amazon.com>
Signed-off-by: George Chen <qchea@amazon.com>
@chenqi0805 chenqi0805 force-pushed the maint/processor-auto-generation-campaign branch from ae6ec35 to 87a088f Compare July 30, 2024 23:11
@dlvenable dlvenable merged commit cd3e5f5 into opensearch-project:main Jul 31, 2024
5 checks passed
opensearch-trigger-bot bot pushed a commit that referenced this pull request Jul 31, 2024
MAINT: documentation update for processors

Signed-off-by: George Chen <qchea@amazon.com>
(cherry picked from commit cd3e5f5)
Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
mingshl pushed a commit to mingshl/documentation-website that referenced this pull request Aug 2, 2024
…t#7713)

MAINT: documentation update for processors

Signed-off-by: George Chen <qchea@amazon.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants