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

fix(OTEL): audit of OTEL docs #18627

Merged

ally-sassman merged 32 commits into develop from OTEL-doc-review

Sep 30, 2024

Contributor

ally-sassman commented Sep 10, 2024 •

edited

Loading

This PR covers an extensive review of the OTEL docs:

The user flow from page to page makes sense and is intuitive
The left nav naming system makes sense and is consistent
No broken links
All screenshots and images are up to date
All "collector" references are capitalized
Key pages are cleaned up for clarity


          fix(OTEL): edits to OTEL intro doc

2ffc9f0

ally-sassman self-assigned this

github-actions bot commented Sep 10, 2024

Hi @ally-sassman 👋

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.

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

netlify bot commented Sep 10, 2024 •

edited

Loading

✅ Deploy Preview for docs-website-netlify ready!

Name	Link
🔨 Latest commit	`b725826`
🔍 Latest deploy log	https://app.netlify.com/sites/docs-website-netlify/deploys/66fa8ff9b55252000804d722
😎 Deploy Preview	https://deploy-preview-18627--docs-website-netlify.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

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

ally-sassman added 6 commits

September 10, 2024 12:08


          Other fixes to overview page, updated yml naming

550d5d9


          fix(OTEL): updates to getting started overview

3723d47


          fix(OTEL): add tiles

2a4cb11


          Update opentelemetry-get-started-intro.mdx

2f37aaf


          update links on data overview page

a591ab0


          other fixes

029322c

ally-sassman added content from_tw labels

ally-sassman and others added 7 commits

September 17, 2024 09:23


          Other fixes

56441c8


          Update opentelemetry-data-overview.mdx

511990b


          revert yml changes

7a79fb3


          uppercase all references of "Collector"

ad7b013


          improve troubleshooting page

dfc31bc


          other fixes

ed40507


          Merge branch 'develop' into OTEL-doc-review

ea790dc

github-actions bot commented Sep 26, 2024

Warning

ruby-agent-configuration.mdx is an autogenerated file.

To change the Ruby agent configuration file, please submit an issue or open a PR in the newrelic/newrelic-ruby-agent repo.


          Update opentelemetry-otlp.mdx

60bccfc

github-actions bot commented Sep 26, 2024

Warning

ruby-agent-configuration.mdx is an autogenerated file.

To change the Ruby agent configuration file, please submit an issue or open a PR in the newrelic/newrelic-ruby-agent repo.


          remove space between api and sdk

bfecb66

ally-sassman marked this pull request as ready for review

September 26, 2024 21:58

github-actions bot requested a review from nbaenam

September 26, 2024 21:58

ally-sassman requested review from alanwest and jack-berg

September 26, 2024 21:58

ally-sassman commented

View reviewed changes

...erless-function-monitoring/aws-lambda-monitoring/opentelemetry/lambda-opentelemetry-java.mdx Outdated Show resolved Hide resolved


          Update opentelemetry-best-practices-traces.mdx

4e31f04

github-actions bot commented Sep 26, 2024

Warning

ruby-agent-configuration.mdx is an autogenerated file.

To change the Ruby agent configuration file, please submit an issue or open a PR in the newrelic/newrelic-ruby-agent repo.


          remove collector titlecase from non-OTel references

github-actions bot commented Sep 26, 2024

Warning

ruby-agent-configuration.mdx is an autogenerated file.

To change the Ruby agent configuration file, please submit an issue or open a PR in the newrelic/newrelic-ruby-agent repo.


          fix last remaining collector references

dc78891

github-actions bot commented Sep 26, 2024

Warning

ruby-agent-configuration.mdx is an autogenerated file.

To change the Ruby agent configuration file, please submit an issue or open a PR in the newrelic/newrelic-ruby-agent repo.

ally-sassman commented

View reviewed changes

src/content/docs/apm/agents/ruby-agent/configuration/ruby-agent-configuration.mdx Outdated Show resolved Hide resolved

ally-sassman and others added 4 commits

September 26, 2024 15:48


          Update src/content/docs/apm/agents/ruby-agent/configuration/ruby-agen…

af1d7d8

…t-configuration.mdx


          Update apm-agent-security-python.mdx

0a24074


          Merge branch 'OTEL-doc-review' of https://github.com/newrelic/docs-we…

c9a55b2

…bsite into OTEL-doc-review


          Update src/content/docs/serverless-function-monitoring/aws-lambda-mon…

6f540b5

…itoring/opentelemetry/lambda-opentelemetry-java.mdx

ally-sassman commented

View reviewed changes

src/nav/opentelemetry.yml Outdated Show resolved Hide resolved


          Update src/nav/opentelemetry.yml

c396eee

ally-sassman commented

View reviewed changes

src/nav/opentelemetry.yml Outdated Show resolved Hide resolved

ally-sassman and others added 3 commits

September 26, 2024 15:52


          Update src/nav/opentelemetry.yml

5373ff8


          update screenshot

8269a0c


          Merge branch 'OTEL-doc-review' of https://github.com/newrelic/docs-we…

5628c94

…bsite into OTEL-doc-review

nbaenam previously approved these changes

View reviewed changes

Contributor

nbaenam left a comment •

edited

Loading

Great job!! I added some suggestions! Take them or leave them ;-)

src/content/docs/opentelemetry/best-practices/opentelemetry-data-overview.mdx Outdated Show resolved Hide resolved

src/content/docs/kubernetes-pixie/kubernetes-integration/installation/k8s-otel.mdx Outdated Show resolved Hide resolved

src/content/docs/opentelemetry/best-practices/opentelemetry-best-practices-metrics.mdx Outdated Show resolved Hide resolved

src/content/docs/opentelemetry/best-practices/opentelemetry-best-practices-resources.mdx Outdated Show resolved Hide resolved

src/content/docs/opentelemetry/best-practices/opentelemetry-manage-data-ingest-volume.mdx Outdated Show resolved Hide resolved

.../opentelemetry/get-started/collector-processing/opentelemetry-collector-processing-intro.mdx Outdated

@@ @@ -17,7 +17,7 @@ translationType: machine @@
                 width="40%"
                 style={{align: "left"}}
                 title="Diagram of OTLP with collector"

Contributor

nbaenam Sep 27, 2024

title="Diagram of OTLP with collector"

.../opentelemetry/get-started/collector-processing/opentelemetry-collector-processing-intro.mdx Outdated

                 width="40%"
                 style={{align: "left"}}
                 title="Diagram of OTLP with collector"

Contributor

nbaenam Sep 27, 2024

title="Diagram of OTLP with collector"

...es-pixie/kubernetes-integration/advanced-configuration/link-otel-applications-kubernetes.mdx Outdated

                 <Step>
                   ### Configure the Kubernetes Attributes processor (discovery filter) [#discovery-filter]
-                  When running the collector as an agent, you should apply a discovery filter so that the processor only discovers pods from the same host that it is running on. If you don't use a filter, resource usage can be unnecessarily high, especially on very large clusters. Once the filter is applied, each processor will only query the Kubernetes API for pods running on its own node.
+                  When running the Collector as an agent, you should apply a discovery filter so that the processor only discovers pods from the same host that it is running on. If you don't use a filter, resource usage can be unnecessarily high, especially on very large clusters. Once the filter is applied, each processor will only query the Kubernetes API for pods running on its own node.

Contributor

nbaenam Sep 27, 2024

I would write this:
the same host that it's running on.

src/content/docs/apm/apm-ui-pages/monitoring/external-services/external-services-setup.mdx Outdated Show resolved Hide resolved

src/content/docs/opentelemetry/opentelemetry-introduction.mdx Outdated Show resolved Hide resolved


          merge changes from #18683

f47549b

ally-sassman dismissed nbaenam’s stale review via

f47549b

September 27, 2024 17:08

ally-sassman added 2 commits

September 27, 2024 10:18


          remove slash from apis/sdks references

275eb36


          add missing lowercased collector references

d63d714

ally-sassman commented

View reviewed changes

src/content/docs/apm/apm-ui-pages/monitoring/external-services/external-services-setup.mdx Outdated Show resolved Hide resolved

src/content/docs/infrastructure/other-infrastructure-integrations/monitoring-airflow-ot.mdx Outdated Show resolved Hide resolved

src/content/docs/kubernetes-pixie/kubernetes-integration/installation/k8s-otel.mdx Outdated Show resolved Hide resolved

src/content/docs/kubernetes-pixie/kubernetes-integration/installation/k8s-otel.mdx Outdated Show resolved Hide resolved

src/content/docs/kubernetes-pixie/kubernetes-integration/installation/k8s-otel.mdx Outdated Show resolved Hide resolved

src/content/docs/opentelemetry/opentelemetry-introduction.mdx Outdated Show resolved Hide resolved

.../opentelemetry/get-started/collector-processing/opentelemetry-collector-processing-intro.mdx Outdated Show resolved Hide resolved

.../opentelemetry/get-started/collector-processing/opentelemetry-collector-processing-intro.mdx Outdated Show resolved Hide resolved

.../opentelemetry/get-started/collector-processing/opentelemetry-collector-processing-intro.mdx Outdated Show resolved Hide resolved

.../opentelemetry/get-started/collector-processing/opentelemetry-collector-processing-intro.mdx Outdated Show resolved Hide resolved


          Apply suggestions from code review

5dc2ea5

ally-sassman changed the title ~~fix(OTEL): edits to OTEL intro doc~~ fix(OTEL): audit of OTEL docs

nbaenam self-requested a review

September 30, 2024 09:20


          fix(OTEL): Fixing a popover

b725826

nbaenam approved these changes

View reviewed changes

Contributor

nbaenam left a comment

Super great work!!

ally-sassman merged commit bd6886a into develop

20 checks passed

ally-sassman deleted the OTEL-doc-review branch

September 30, 2024 16:10

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

content from_tw