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

Document latest Metrics SDK #3026

Closed
1 of 7 tasks
legendecas opened this issue Jun 8, 2022 · 5 comments
Closed
1 of 7 tasks

Document latest Metrics SDK #3026

legendecas opened this issue Jun 8, 2022 · 5 comments
Labels
document Documentation-related sdk:metrics Issues and PRs related to the Metrics SDK
Milestone

Comments

@legendecas
Copy link
Member

legendecas commented Jun 8, 2022

We need to update the standalone documents of Metrics SDK to help people understand the metrics spec changes and how JavaScript SDK implements them.

@legendecas legendecas added the document Documentation-related label Jun 8, 2022
@legendecas legendecas added this to the Metrics GA milestone Jun 8, 2022
@dyladan
Copy link
Member

dyladan commented Jun 8, 2022

I believe all docs should be moved to the website. We can iterate on them here and move them to the website when we're happy with them?

@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.

@github-actions github-actions bot added the stale label Aug 29, 2022
@legendecas legendecas added sdk:metrics Issues and PRs related to the Metrics SDK and removed stale labels Aug 29, 2022
@cartermp
Copy link
Contributor

This was discussed a bit at the maintainer's meeting last week. On the docs side, we have outlines that can be followed now!

Getting started: open-telemetry/opentelemetry.io#1746 (comment)
Manual instrumentation: open-telemetry/opentelemetry.io#1746 (comment)

As mentioned in the call, if y'all can contribute a code sample that handles initialization of metrics in the most correct way, then we (docs SIG) can probably cover the rest iteratively.

I also think that JS getting started is unique, since there's really two major SDKs that people use, whereas other languages just have one way to get started. I'd recommend that for now, we focus on the Manual Instrumentation doc and then figure out the right way to structure the JS getting started docs orthogonally.

@dyladan
Copy link
Member

dyladan commented Sep 19, 2022

Sorry to leave you hanging for so long I promise I haven't forgotten this. I'll make sure to get something tomorrow even if it isn't completely polished so you have something to work with.

@cartermp
Copy link
Contributor

Sounds good!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
document Documentation-related sdk:metrics Issues and PRs related to the Metrics SDK
Projects
None yet
Development

No branches or pull requests

3 participants