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

Transfer OpenTelemetry OTLP docs to public site #4004

Merged
merged 31 commits into from
Sep 23, 2021
Merged

Transfer OpenTelemetry OTLP docs to public site #4004

merged 31 commits into from
Sep 23, 2021

Conversation

rhetoric101
Copy link
Contributor

@rhetoric101 rhetoric101 commented Sep 22, 2021 •
edited

These are the docs that were created on the private site and are now ready for review. Please look closely at the following:

INTRODUCTION

  • Added links in "Benefits of OpenTelemetry"
  • Added Slack link in "Should I use OpenTelemetry instrumentation or New Relic agents?"
  • Added new wording and tables to "How OpenTelemetry works with New Relic," including a link to Slack.

QUICK START

Step 3 was revamped and divided into two sub-sections. Please review the entire step and links.

BEST PRACTICES

  • Added a new mini table of contents at top.
  • Added two new sub-sections to the Traces section.
  • Added new Metrics section.
  • Added new introductory content to existing Log section.

VIEW YOUR OPENTELEMETRY DATA

  • Added details to each view section explaining how to ensure the UI lights up with your data.
  • Added new section "Narrow down your data with filters"
  • Modified the first paragraph in "Distributed tracing"
  • Metrics explorer now has a screenshot

FEDRAMP-COMPLIANT ENDPOINTS

This document now has the FedRamp OTLP endpoints and is references from the quick start: https://docswebsitedevelop-rhsotlpgadoc7276.gtsb.io/docs/security/security-privacy/compliance/fedramp-compliant-endpoints/#otlp-api

I didn't make any changes to "Legacy New Relic OpenTelemetry Exporters" but you are welcome to review it.

@rhetoric101
feat(OpenTelemetry): Added tables showing support for OTLP metrics an…
ef78466 
…d traces
@rhetoric101
feat(OpenTelemetry): Starting removing pre-release references. Added …
85f8784 
…beta doc material.
@rhetoric101
feat(OTEL): Added a table from the beta doc with NR settings.
23d75de
@rhetoric101
feat(OTEL): Added span event information that is from another branch
d36c9f8
@rhetoric101
fix(OTEL): Added closing slash to <thead>
d25c9ca
@rhetoric101
fix(OTEL): Corrected malformed table heading tag.
4e91dc6
@rhetoric101
feat(OTEL): Added attributes you need to light up UI.
a3ba7cc
@rhetoric101
feat(OTEL): Rearranged topics on UI page to alphabetical
906d8f3
@rhetoric101
feat(OTEL): Cleanned up some topics in preparation for initial review
6421059
@rhetoric101
feat(OpenTelemetry): Added tables showing support for OTLP metrics an…
a598f56 
…d traces
@rhetoric101
feat(OpenTelemetry): Starting removing pre-release references. Added …
9716831 
…beta doc material.
@rhetoric101
feat(OTEL): Added a table from the beta doc with NR settings.
08e7283
@rhetoric101
feat(OTEL): Added span event information that is from another branch
4e86ffc
@rhetoric101
fix(OTEL): Added closing slash to <thead>
6382b7a
@rhetoric101
fix(OTEL): Corrected malformed table heading tag.
bc3cf74
@rhetoric101
feat(OTEL): Added attributes you need to light up UI.
d9584a3
@rhetoric101
feat(OTEL): Rearranged topics on UI page to alphabetical
ca76837
@rhetoric101
feat(OTEL): Cleanned up some topics in preparation for initial review
1b046cc
@rhetoric101
fix(OTEL): Fixed misspellings of OpenTelemetry.
03590ac
@rhetoric101
feat(OTEL): Added improvements based on SME feedback.
f362494
@rhetoric101
feat(OTEL): Introducing new wording about choosing OTEL.
a150409
@rhetoric101
feat(OTEL): Restoring original text about choosing OTEL.
2f45572
@rhetoric101
feat(OTEL): Added iniital metrics details from SME.
63fbc4f
@rhetoric101
fix(OTEL): Ran spell check on topics
bbb8b93
@rhetoric101
feat(OTEL): Added histogram and start time details.
77454b6
@rhetoric101
feat(OTEL): Improved support matrix and moved FedRamp endpoint
9e16c2e
@rhetoric101
feat(OTEL): Replaced UI links to signals and corrected some URLs.
315ca2b
@rhetoric101
feat(OTEL): Added initial logging support details.
4777370
@rhetoric101
feat(OTEL): Added more content from SMEs for intro and best practices
b65bd0d
@rhetoric101
fix(OTEL): Made final edits in private site before migration.
f1d6d5d
@github-actions github-actions bot added this to Hero to triage in Docs PRs and Issues Sep 22, 2021
@gatsby-cloud
Copy link

gatsby-cloud bot commented Sep 22, 2021 •
edited

Gatsby Cloud Build Report

docs-website-develop

🎉 Your build was successful! See the Deploy preview here.

Build Details

View the build logs here.

🕐 Build time: 29m

@rhetoric101 rhetoric101 self-assigned this Sep 22, 2021
@rhetoric101 rhetoric101 added content requests related to docs site content from_tw Identifies issues/PRs from Tech Docs writers labels Sep 22, 2021
@rhetoric101 rhetoric101 moved this from Hero to triage to Writer needs PR review (Hero or any TW can take) in Docs PRs and Issues Sep 22, 2021
@rhetoric101 rhetoric101 moved this from Writer needs PR review (Hero or any TW can take) to Writer needs peer edit (Hero or any TW can take) in Docs PRs and Issues Sep 22, 2021
@rhetoric101
Copy link
Contributor Author

@mmfred, this work is covered in DOC-7352, which is a follow up to DOC-7276.

mmfred
mmfred previously approved these changes Sep 22, 2021
View reviewed changes
Copy link
Contributor

@mmfred mmfred left a comment

Choose a reason for hiding this comment

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

Hi Rob - many of these are nice to have changes, rather than required. But there are a few broken links and dropped words. I'm approving so you can fix those things without having to worry or wait on a review.

...ns/open-source-telemetry-integrations/opentelemetry/introduction-opentelemetry-new-relic.mdx Outdated Show resolved Hide resolved
...ns/open-source-telemetry-integrations/opentelemetry/introduction-opentelemetry-new-relic.mdx Show resolved Hide resolved
...ns/open-source-telemetry-integrations/opentelemetry/introduction-opentelemetry-new-relic.mdx Outdated Show resolved Hide resolved
...ns/open-source-telemetry-integrations/opentelemetry/introduction-opentelemetry-new-relic.mdx Show resolved Hide resolved
...ns/open-source-telemetry-integrations/opentelemetry/introduction-opentelemetry-new-relic.mdx Show resolved Hide resolved
...ocs/integrations/open-source-telemetry-integrations/opentelemetry/opentelemetry-concepts.mdx Outdated Show resolved Hide resolved
...ocs/integrations/open-source-telemetry-integrations/opentelemetry/opentelemetry-concepts.mdx Show resolved Hide resolved
.../open-source-telemetry-integrations/opentelemetry/view-your-opentelemetry-data-new-relic.mdx Show resolved Hide resolved
.../open-source-telemetry-integrations/opentelemetry/view-your-opentelemetry-data-new-relic.mdx Outdated Show resolved Hide resolved
.../open-source-telemetry-integrations/opentelemetry/view-your-opentelemetry-data-new-relic.mdx Show resolved Hide resolved
@rhetoric101 rhetoric101 merged commit 96bbaac into develop Sep 23, 2021
@rhetoric101 rhetoric101 deleted the rhs-otlp-ga-doc-7276 branch September 23, 2021 02:19
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@rkbodenner rkbodenner rkbodenner left review comments

@mmfred mmfred mmfred left review comments

Assignees

@rhetoric101 rhetoric101

Labels
content requests related to docs site content from_tw Identifies issues/PRs from Tech Docs writers
Projects
Docs PRs and Issues
In review
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
3 participants
@rhetoric101 @rkbodenner @mmfred