Skip to content

Conversation

@vagrawal-newrelic
Copy link
Contributor

…ation

Please follow conventional commit standards
in your commit messages and pull request title.

Give us some context

  • What problems does this PR solve?
  • Add any context that will help us review your changes such as testing notes,
    links to related docs, screenshots, etc.
  • If your issue relates to an existing GitHub issue, please link to it.

@github-actions
Copy link

Hi @vagrawal-newrelic 👋

Thanks for your pull request! Your PR is in a queue, and a writer will take a look soon. We generally publish small edits within one business day, and larger edits within three days.

Please ensure the propsed changes look good by building it first in your local environment. Refer to this contribution guide to get the site up and running in your local.

If you really require a preview url, reach out to one of the writers and they will generate one for you.

@PallaviWrite
Copy link
Contributor

netlify build fork

@svc-docs-eng-opensource-bot
Copy link
Contributor

✅ Your PR has been mirrored to our repository as PR #22590.
Commit: d222459a99d622b8550a127229c63e808afa3dfd (d222459)
Our workflows will run in the mirrored PR linked above.
🚀 If the build is successful, a Netlify preview will be available shortly at: https://vagrawal-newrelic-es-otel-docs-changes--docs-website-netlify.netlify.app

@PallaviWrite
Copy link
Contributor

netlify build fork

@svc-docs-eng-opensource-bot
Copy link
Contributor

✅ Your updates have been mirrored to our repository in PR #22590.
Commit: 6604a03c776b4010a96f9b02a901b451aa07466d (6604a03)
Our workflows will run in the mirrored PR linked above.
🚀 If the build is successful, a Netlify preview will be updated shortly at: https://vagrawal-newrelic-es-otel-docs-changes--docs-website-netlify.netlify.app

PallaviWrite and others added 8 commits December 31, 2025 15:07
…erience

- Rewrite introduction with clearer value proposition and use case
- Add structured "What you'll get" and "Before you begin" sections
- Simplify technical language for broader accessibility
- Improve content flow following New Relic style guidelines
- Add clear prerequisites and setup time expectations

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <[email protected]>
…e redundancy

Overview document improvements:
- Remove duplicate metrics between summary and detailed tables
- Move prerequisites to installation doc for better UX flow
- Eliminate redundant sections for cleaner reading experience
- Focus overview on value proposition and benefits

Installation document improvements:
- Enhance "Before you begin" section with time estimates
- Add Step 5 for alerts setup (moved from overview)
- Update step navigation to include all 5 steps
- Improve prerequisites formatting and clarity

This creates better separation of concerns:
- Overview: What you get and why to use it
- Installation: What you need and how to set it up

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <[email protected]>
- Fix broken link in overview document's Next Steps section
- Update path from /docs/more-integrations/... to /docs/opentelemetry/get-started/...
- Ensure users can properly navigate to related OpenTelemetry integrations

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <[email protected]>
- Update title to action-oriented "Install Elasticsearch OpenTelemetry integration"
- Improve introduction with clearer language about what the guide does
- Add descriptive step navigation with explanations of each step
- Fix broken localhost URL in prerequisites section
- Add important callout in Step 2 highlighting required customizations
- Enhance Step 3 with clearer language about environment variables
- Significantly improve Step 4 with success indicators and troubleshooting tips
- Add helpful "Next steps with your data" guidance
- Fix capitalization inconsistencies (OpenTelemetry vs Opentelemetry)

The installation document now provides better user guidance and clearer expectations at each step, making it much more GA-ready.

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <[email protected]>
…ation discovery

Traditional Elasticsearch integration improvements:
- Add prominent callout promoting new OpenTelemetry alternative
- Guide users to modern OTEL-based monitoring option
- Highlight benefits: vendor neutrality, enhanced performance, future-proof architecture

OpenTelemetry integration improvements:
- Add bidirectional cross-reference to traditional integration
- Provide clear choice guidance without being pushy
- Enhanced tags for better discoverability and SEO
- Added comprehensive tagging: OpenTelemetry, OTEL, On-host integrations

This fulfills the JIRA requirement for cross-linking existing OHI documentation
to ensure customers can easily find the new OpenTelemetry path.

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants