fix(collector/quick-start): clarify demo scope, explain ports, improve prerequisites by favxlaw · Pull Request #9622 · open-telemetry/opentelemetry.io

favxlaw · 2026-04-10T09:41:34Z

I have read and followed the Contributing docs, especially the "First-time contributing?" section.
This PR has content that I did not fully write myself.
- I used AI and I have read and followed the Generative AI Contribution Policy.
I have the experience and knowledge necessary to understand, review, and validate all content in this PR.¹

Fixes #9589

Added a Note alert at the top to make clear this is an introductory demo and not a production setup, this addresses the root cause @jade-guiton-dd raised in the issue.
Updated the prerequisites section to explain which step each tool is needed for.
Added a port explanation after the docker run command, including what ZPages is .
Removed the OCB link from Next steps since it's out of scope for a quick start.
Reordered Next steps so they follow a logical order, with quick explanations for each, making it easier to move through.

PREVIEW: https://deploy-preview-9622--opentelemetry.netlify.app/docs/collector/quick-start/

Yes, I can answer maintainer questions about the content of this PR, without using AI. ↩

…prove prerequisites

linux-foundation-easycla · 2026-04-10T09:41:42Z

The committers listed above are authorized under a signed CLA.

✅ login: favxlaw / name: Favour Lawrence (0682eb2, 06a34f4, 071a440, 33b690c, 6a705f6, 6f52716, 75ec5cd, 76b94e2, 82df667, 84dd188, 852d7b7, 8976975, 89b208d, 9a46dec, a0f0171, e58f789, fb8e945)
✅ login: favxlaw / name: favxlaw (9f2f09b, fb247e7)
✅ login: mx-psi / name: Pablo Baeyens (071a440)
✅ login: otelbot[bot] / name: otelbot (20fe5f1, 7f9bf00, 94167fb)
✅ login: tiffany76 / name: Tiffany Hrabusa (0682eb2, 06a34f4, 33b690c, 6a705f6, 6f52716, 75ec5cd, 76b94e2, 82df667, 84dd188, 852d7b7, 8976975, 9a46dec, a0f0171, e58f789, fb8e945)

vitorvasc · 2026-04-13T14:17:37Z

/fix:format

otelbot-docs · 2026-04-13T14:20:27Z

✅ fix:format applied successfully in run 24348376181.

tiffany76

Thanks for taking this on, @favxlaw! It's a big help. We're currently doing a major overhaul of the Collector docs in general, so I took this opportunity to polish things up. Let me know if you have any questions!

Co-authored-by: Tiffany Hrabusa <30397949+tiffany76@users.noreply.github.com>

tiffany76

Looking good, @favxlaw! Just a couple tiny changes, and then I think this is good from a copy-edit perspective.

@open-telemetry/collector-approvers, PTAL!

Co-authored-by: Tiffany Hrabusa <30397949+tiffany76@users.noreply.github.com>

favxlaw · 2026-04-14T20:16:59Z

Looking good, @favxlaw! Just a couple tiny changes, and then I think this is good from a copy-edit perspective.

@open-telemetry/collector-approvers, PTAL!

Thank you for the review @tiffany76 , I really appreciate the guidance :)

tiffany76 · 2026-04-14T20:26:24Z

/fix

otelbot-docs · 2026-04-14T20:36:19Z

✅ fix applied successfully in run 24421228723.

Co-authored-by: Pablo Baeyens <pbaeyens31+github@gmail.com>

tiffany76 · 2026-04-15T18:28:16Z

/fix:format

otelbot-docs · 2026-04-15T18:31:07Z

✅ fix:format applied successfully in run 24471282649.

tiffany76

Thanks very much, @favxlaw! We appreciate your contribution!

otelbot · 2026-04-15T18:45:38Z

Thank you for your contribution @favxlaw! 🎉 We would like to hear from you about your experience contributing to OpenTelemetry by taking a few minutes to fill out this survey.

favxlaw · 2026-04-15T19:49:51Z

Thanks very much, @favxlaw! We appreciate your contribution!

Thank you for the opportunity :)

Definitely sth I will love to do again 😊

fix(collector/quick-start): clarify demo scope, explain ports, and im…

fb247e7

…prove prerequisites

favxlaw requested a review from a team as a code owner April 10, 2026 09:41

github-project-automation bot added this to SIG Comms: PRs & Issues Apr 10, 2026

github-actions bot added the sig:collector label Apr 10, 2026

otelbot-docs bot requested review from a team and evan-bradley and removed request for a team April 10, 2026 09:41

otelbot-docs bot added missing:docs-approval Co-owning SIG has provided approval, PR needs approval from docs maintainer missing:sig-approval Co-owning SIG didn't provide an approval labels Apr 10, 2026

Merge branch 'main' into fix/collector-quickstart-clarity

89b208d

otelbot-docs bot requested a review from a team April 10, 2026 09:42

Results from /fix directive

7f9bf00

tiffany76 reviewed Apr 14, 2026

View reviewed changes

favxlaw and others added 14 commits April 14, 2026 02:44

Update content/en/docs/collector/quick-start.md

9a46dec

Co-authored-by: Tiffany Hrabusa <30397949+tiffany76@users.noreply.github.com>

Update content/en/docs/collector/quick-start.md

fb8e945

Co-authored-by: Tiffany Hrabusa <30397949+tiffany76@users.noreply.github.com>

Update content/en/docs/collector/quick-start.md

84dd188

Co-authored-by: Tiffany Hrabusa <30397949+tiffany76@users.noreply.github.com>

Update content/en/docs/collector/quick-start.md

8976975

Co-authored-by: Tiffany Hrabusa <30397949+tiffany76@users.noreply.github.com>

Update content/en/docs/collector/quick-start.md

852d7b7

Co-authored-by: Tiffany Hrabusa <30397949+tiffany76@users.noreply.github.com>

Update content/en/docs/collector/quick-start.md

82df667

Co-authored-by: Tiffany Hrabusa <30397949+tiffany76@users.noreply.github.com>

Update content/en/docs/collector/quick-start.md

a0f0171

Co-authored-by: Tiffany Hrabusa <30397949+tiffany76@users.noreply.github.com>

Update content/en/docs/collector/quick-start.md

06a34f4

Co-authored-by: Tiffany Hrabusa <30397949+tiffany76@users.noreply.github.com>

Update content/en/docs/collector/quick-start.md

6f52716

Co-authored-by: Tiffany Hrabusa <30397949+tiffany76@users.noreply.github.com>

Update content/en/docs/collector/quick-start.md

0682eb2

Co-authored-by: Tiffany Hrabusa <30397949+tiffany76@users.noreply.github.com>

Update content/en/docs/collector/quick-start.md

76b94e2

Co-authored-by: Tiffany Hrabusa <30397949+tiffany76@users.noreply.github.com>

Update content/en/docs/collector/quick-start.md

75ec5cd

Co-authored-by: Tiffany Hrabusa <30397949+tiffany76@users.noreply.github.com>

Update content/en/docs/collector/quick-start.md

33b690c

Co-authored-by: Tiffany Hrabusa <30397949+tiffany76@users.noreply.github.com>

fix: restore code block indentation and remove unused reference links

9f2f09b

tiffany76 reviewed Apr 14, 2026

View reviewed changes

Comment thread content/en/docs/collector/quick-start.md Outdated

Comment thread content/en/docs/collector/quick-start.md Outdated

favxlaw and others added 2 commits April 14, 2026 21:05

Update content/en/docs/collector/quick-start.md

6a705f6

Co-authored-by: Tiffany Hrabusa <30397949+tiffany76@users.noreply.github.com>

Update content/en/docs/collector/quick-start.md

e58f789

Co-authored-by: Tiffany Hrabusa <30397949+tiffany76@users.noreply.github.com>

tiffany76 added the sig:collector:refactor These issues are part of the Collector documentation refactoring project. label Apr 14, 2026

Results from /fix directive

20fe5f1

mx-psi reviewed Apr 15, 2026

View reviewed changes

Comment thread content/en/docs/collector/quick-start.md Outdated

Update content/en/docs/collector/quick-start.md

071a440

Co-authored-by: Pablo Baeyens <pbaeyens31+github@gmail.com>

otelbot-docs bot requested a review from a team April 15, 2026 11:52

mx-psi approved these changes Apr 15, 2026

View reviewed changes

otelbot-docs bot removed the missing:sig-approval Co-owning SIG didn't provide an approval label Apr 15, 2026

Results from /fix directive

94167fb

otelbot-docs bot requested a review from a team April 15, 2026 18:31

tiffany76 approved these changes Apr 15, 2026

View reviewed changes

tiffany76 added this pull request to the merge queue Apr 15, 2026

otelbot-docs bot added ready-to-be-merged This PR is ready to be merged by a maintainer and removed missing:docs-approval Co-owning SIG has provided approval, PR needs approval from docs maintainer labels Apr 15, 2026

tiffany76 mentioned this pull request Apr 15, 2026

[Docs]: Improve clarity and developer experience of the Collector quick start page #9589

Closed

Merged via the queue into open-telemetry:main with commit dde316c Apr 15, 2026
25 checks passed

github-project-automation bot moved this to Done in SIG Comms: PRs & Issues Apr 15, 2026

Conversation

favxlaw commented Apr 10, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Footnotes

Uh oh!

linux-foundation-easycla bot commented Apr 10, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

vitorvasc commented Apr 13, 2026

Uh oh!

otelbot-docs bot commented Apr 13, 2026

Uh oh!

tiffany76 left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

tiffany76 left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

favxlaw commented Apr 14, 2026

Uh oh!

tiffany76 commented Apr 14, 2026

Uh oh!

otelbot-docs bot commented Apr 14, 2026

Uh oh!

Uh oh!

tiffany76 commented Apr 15, 2026

Uh oh!

otelbot-docs bot commented Apr 15, 2026

Uh oh!

tiffany76 left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

otelbot bot commented Apr 15, 2026

Uh oh!

favxlaw commented Apr 15, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

favxlaw commented Apr 10, 2026 •

edited

Loading

linux-foundation-easycla bot commented Apr 10, 2026 •

edited

Loading