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

Found some broken links. #2413

Closed
justinabrahms opened this issue Aug 12, 2021 · 11 comments
Closed

Found some broken links. #2413

justinabrahms opened this issue Aug 12, 2021 · 11 comments
Assignees
Labels
bug Something isn't working good first issue Good for newcomers stale

Comments

@justinabrahms
Copy link

https://open-telemetry.github.io/opentelemetry-js/

I clicked "SDK docs" in the readme, which took me to https://open-telemetry.github.io/opentelemetry-js/

There, I opened both the getting started guide and the node auto-setup thing in this paragraph:

To get started tracing your own application, see the Getting Started Guide. For more information about automatic instrumentation see @opentelemetry/node, which provides auto-instrumentation for Node.js applications.

Both were broken links, which was unexpected.

@justinabrahms justinabrahms added the bug Something isn't working label Aug 12, 2021
@dyladan
Copy link
Member

dyladan commented Sep 1, 2021

Thanks for bringing this up :)

@dyladan dyladan added the good first issue Good for newcomers label Sep 1, 2021
@JamesJHPark
Copy link
Contributor

@alolita - please assign me this issue

@alolita
Copy link
Member

alolita commented Sep 8, 2021

@dyladan can you please assign @JamesJHPark to work on this issue? ty!

@pragmaticivan
Copy link
Contributor

Assuming this issue should be closed?
ref: #2463

@justinabrahms
Copy link
Author

@pragmaticivan No. There are still several broken links on https://open-telemetry.github.io/opentelemetry-js/ including at least 2 links for the getting started guide.

@JamesJHPark
Copy link
Contributor

@dyladan - Hi, I was wondering if the issue of broken links on https://open-telemetry.github.io/opentelemetry-js/
may be related to timeline of the updates in gh-pages index.html? I have noticed the change to Upgrade guidelines for 0.25.x to 1.x.y from recent commits to README.md in main is also not reflected on the page. Thank you.

@dyladan
Copy link
Member

dyladan commented Sep 29, 2021

The docs on github.io are automatically published when there is a release. This ensures the docs always reference the most recent released package and don't document unreleased changes.

@github-actions
Copy link

github-actions bot commented Dec 6, 2021

This issue is stale because it has been open 60 days with no activity. Remove stale label or comment or this will be closed in 14 days.

@github-actions github-actions bot added the stale label Dec 6, 2021
@dyladan
Copy link
Member

dyladan commented Dec 10, 2021

@JamesJHPark are you still working on this or have these been fixed?

@github-actions github-actions bot removed the stale label Dec 13, 2021
@JamesJHPark
Copy link
Contributor

@dyladan the broken links discussed in this issue description have been fixed in the PR. This is also related to the issue #2662.

@github-actions
Copy link

This issue is stale because it has been open 60 days with no activity. Remove stale label or comment or this will be closed in 14 days.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working good first issue Good for newcomers stale
Projects
None yet
Development

No branches or pull requests

6 participants