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

feat(Getting Started): Added a new getting started page #16312

Merged
merged 26 commits into from
Apr 5, 2024

Conversation

nbaenam
Copy link
Contributor

@nbaenam nbaenam commented Feb 27, 2024

Added a new getting started page.

@nbaenam nbaenam added content requests related to docs site content from_tw Identifies issues/PRs from Tech Docs writers labels Feb 27, 2024
@nbaenam nbaenam self-assigned this Feb 27, 2024
Copy link

Hi @nbaenam 👋

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.

Gatsby Cloud will automatically generate a preview of your request, and will comment with a link when the preview is ready (usually 20 to 30 minutes).

Copy link

netlify bot commented Feb 27, 2024

Deploy Preview for docs-website-netlify ready!

Name Link
🔨 Latest commit 96bca33
🔍 Latest deploy log https://app.netlify.com/sites/docs-website-netlify/deploys/66103a1173163b00086ef47d
😎 Deploy Preview https://deploy-preview-16312--docs-website-netlify.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@nbaenam nbaenam removed the request for review from bradleycamacho February 27, 2024 14:12
Copy link

github-actions bot commented Feb 27, 2024

Netlify Preview Deployment Information

This comment will auto update when your preview build is ready

<SideBySide>
<Side>

OpenTelemetry helps collect data from your applications and hosts, sending it to New Relic. New Relic's platform lets you analyze the data and fix any application problems. This toolkit simplifies the process of monitoring and troubleshooting your software. By utilizing OpenTelemetry, you can enhance the performance and reliability of your applications.
Copy link
Contributor

Choose a reason for hiding this comment

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

@rhetoric101 Is OpenTelemetry an integration? I'm a little hazy on the details here, but the way I understand it is that New Relilc has some kind of compatibility with OTel so that OTel customers can forward that data into New Relic.

i think this section might benefit from describing why would someone might OTel and New Relic? Or maybe telling a story about how using New Relic enhances OTel monitoring

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I'm going to wait for what Rob has to say here.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Hey @rhetoric101, could you please check the paragraph and see if it's accurate? Thanks!

Copy link
Contributor

@akristen akristen left a comment

Choose a reason for hiding this comment

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

Hi, hi! I left some comments but I'll summarize at a high level why I suggested certain changes:

  • I don't think we should reference "performance of your apps and service" or "health of your environment" or anything vague like that under every capability, bc it's vague and a little redundant. As an observability platform, it's assumed that we're doing something with performance, health, metrics, etc.
  • When we talk about how a capability improves performance/tracks problems, we should be extremely specific about the kind of data that's being collected and how we're getting it. Not just MELT data, which is assumed, but the data that distinguishes each feature from one another. e.g., referencing packets for network performance monitoring, or clusters/pods for k8s, or HTTP domains for browser. I made a few suggestions for things like that. Since instrumentation is making a technology measurable, we should consider getting pretty specific about what's being measured from that tech, and why that's valuable.
  • On a structural level, I do think we need to move 'How it works' to the front and maybe shorten the intro so both sections can appear above the fold.
  • Explaining at a high level how the install process works and what instrumentation is is important before we frontload a lot of information about how we help you measure/monitor/improve different layers of a system. It's the rule of starting general then getting more specific: we should start generally about how the New Relic platform keeps your data for you, how you access it, then go specifically into the technologies we can collect data from
  • We definitely need an NRDB and NRQL section. NRQL is the main tool that gives people the ability to find data and dashboards/alerts are built on top of it. We don't need to get too specific, but since we deal with data, it might be good to let customers know that you can query it a la SQL... You introduce NRQL already in dashboards, but i think it should be its own thing.
  • NRDB is where the data goes. I def think this is more important than explaining service levels or even a tertiary feature like errors inbox.. Maybe it appears in the intro as a throw away thing. "Your data is then stored in the New Relic Database, or NRDB." It's a pretty key part of the data ingest pipeline so it can appear in a high level explanation of how new relic functions

@nbaenam nbaenam merged commit 9d2e264 into develop Apr 5, 2024
17 checks passed
@nbaenam nbaenam deleted the nb-getting-started-page branch April 5, 2024 18:02
@nbaenam
Copy link
Contributor Author

nbaenam commented Apr 5, 2024

I'm going to merge this PR because 2 TW has already reviewed it.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
content requests related to docs site content from_tw Identifies issues/PRs from Tech Docs writers
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants