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

[website_docs] fix broken links, copyedits and file renames #1120

Merged

Conversation

chalin
Copy link
Contributor

@chalin chalin commented Feb 3, 2022

With these changes, the OTel website build is successful (i.e., #1104 is fixed):

$ GET="no" npm run check-links
...
Skipping the checking of external links.
htmltest started at 05:02:44 on public
========================================================================
✔✔✔ passed in 507.334376ms
tested 540 documents

/assign @cartermp
/cc @austinlparker


[Manual Instrumentation][manual-instrumentation] will give provide you the ability to enrich your traces with domain specific data.

[Automatic Instrumentation][auto-instrumentation]
Copy link
Contributor Author

@chalin chalin Feb 3, 2022

Choose a reason for hiding this comment

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

@cartermp - this entire page talks about automatic instrumentation and that same link is given elsewhere in the page, so it seemed odd to me to mention it again here in the list of "more things to look into". Hence, I removed the reference. Thoughts?

Copy link
Contributor

Choose a reason for hiding this comment

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

Makes sense to me.

Comment on lines -82 to -86
[Context Propagation][context-propagation] is perhaps one of the most powerful concepts in OpenTelemetry because it will upgrade your single service trace into a _distributed trace_, which makes it possible for OpenTelemetry vendors to visualize a request from end-to-end across process and network boundaries.

[Span Events][events] allow you to add a human-readable message on a span that represents "something happening" during its lifetime.

[Manual Instrumentation][manual-instrumentation] will give provide you the ability to enrich your traces with domain specific data.
Copy link
Contributor Author

Choose a reason for hiding this comment

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

@cartermp - note that I converted these paragraphs into a list.

@cartermp
Copy link
Contributor

cartermp commented Feb 3, 2022

(fyi maintainers - I hit approve since I think @chalin's changes make sense w.r.t. what we're doing with docs all-around. I recognize that this requires your approval to move forward 🙂)

@robertlaurin robertlaurin merged commit 6d5a351 into open-telemetry:main Feb 3, 2022
@chalin chalin deleted the chalin-web-docs-link-fix-2022-02-03 branch February 4, 2022 13:54
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.

website_docs contain invalid links
3 participants