docs: add Metrics documentation to project #3360

weyert · 2022-10-25T14:54:58Z

Which problem is this PR solving?

Please include a summary of the change and which issue is fixed. Please also include relevant motivation and context. List any dependencies that are required for this change.

Fixes # (issue)

Short description of the changes

Type of change

Please delete options that are not relevant.

Bug fix (non-breaking change which fixes an issue)
New feature (non-breaking change which adds functionality)
Breaking change (fix or feature that would cause existing functionality to not work as expected)
This change requires a documentation update

How Has This Been Tested?

Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce. Please also list any relevant details for your test configuration

Test A

Checklist:

Followed the style guidelines of this project
Unit tests have been added
Documentation has been updated

codecov · 2022-10-25T15:03:06Z

Codecov Report

Merging #3360 (8047524) into main (7972edf) will decrease coverage by 0.01%.
The diff coverage is n/a.

❗ Current head 8047524 differs from pull request most recent head f227c73. Consider uploading reports for the commit f227c73 to get more accurate results

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #3360      +/-   ##
==========================================
- Coverage   93.25%   93.24%   -0.02%     
==========================================
  Files         247      247              
  Lines        7344     7344              
  Branches     1511     1511              
==========================================
- Hits         6849     6848       -1     
- Misses        495      496       +1

Impacted Files	Coverage Δ
...-trace-base/src/platform/node/RandomIdGenerator.ts	`87.50% <0.00%> (-6.25%)`	⬇️

weyert

style: fix markdown double blank line

weyert

style: fix markdown linting issue

linux-foundation-easycla · 2022-10-25T16:33:04Z

The committers listed above are authorized under a signed CLA.

✅ login: weyert / name: Weyert de Boer (82d602c, 5b648ca, 8ccc7cf)

legendecas

LGTM, thank you for the work!

CHANGELOG.md

doc/metrics.md

Co-authored-by: Chengzhong Wu <legendecas@gmail.com>

dyladan · 2022-11-01T19:56:28Z

@weyert this looks good to me but can you open the PR on the website repo? I think the overall project is trying to move documentation to the website when reasonable

dyladan · 2022-11-01T19:57:06Z

@cartermp may have an opinion there. Last I heard they were using submodules for some languages too. What I don't want is a situation where some docs are here and some are in the website repo.

weyert · 2022-11-01T20:36:00Z

@cartermp may have an opinion there. Last I heard they were using submodules for some languages too. What I don't want is a situation where some docs are here and some are in the website repo.

@cartermp Let me know, what you prefer :)

cartermp · 2022-11-01T21:19:24Z

These should be on the website long-term. My comment on the past PR was that if it's easier to get initial feedback here, then that's good, but all end-user documentation should live on the website. So if this looks like it's good enough for folks, then I would recommend we either:

Merge here --> someone opens a PR on the docs site (I am happy to do so) --> rework to the shape outline here: Document latest Metrics SDK #3026 (comment) either immediately or after it's merged on the site
Everyone says "LGTM" and we open a PR on the docs site without merging here

pichlermarc

LGTM % some nits. Thanks for working on this. 🙂
Sorry for taking so long with the review, was out of office for a while.

CHANGELOG.md

doc/metrics.md

CHANGELOG.md

Co-authored-by: Marc Pichler <marcpi@edu.aau.at>

weyert

I have added the suggested changes

package.json

dyladan · 2022-11-08T21:01:32Z

Updated the PR to use the api package instead of api-metrics. Note that this will not be accurate until after the API is released so this should not be released before that.

pichlermarc

Looks good 🙂 🎉
Thank you for working on this 🙂

cartermp · 2022-11-09T17:21:57Z

So it sounds like the motion will be:

Merge here
We add metrics docs to the website
....something something this file in this repo happens?

I've no strong opinion about what happens in this repo, but we'll want the docs in the website and in the outlined structure at some point.

legendecas · 2022-11-09T17:26:19Z

@cartermp I'm not sure how other languages manage their documentation with the website project. Is there any procedure we can adopt in the JS repo too? I'd be happy to help to alleviate the burden of the website maintainers if this documentation can be moved to the website repo.

cartermp · 2022-11-09T17:37:18Z

Perhaps I confused things with this comment by not advocating to move the PR to the website repo in the first place. Since Metrics docs don't exist yet, if it's faster to get feedback here then a PR here is probably best, but the end state would be to live in the docs. That was my understanding based on conversation in PRs.

All end-user non-api-reference JS docs live in the docs/website repo today, as is also the case for all other languages now aside from Go (which we're proposing to move soon too). These docs will also need to be changed to meet the outline laid out here (linked to from the metrics docs issue on this repo). To be honest, I'm not sure why there's been confusion here.

dyladan · 2022-11-09T19:57:12Z

Perhaps I confused things with this comment by not advocating to move the PR to the website repo in the first place. Since Metrics docs don't exist yet, if it's faster to get feedback here then a PR here is probably best, but the end state would be to live in the docs. That was my understanding based on conversation in PRs.

I agree end state should be docs on website. PR was open here to get feedback.

All end-user non-api-reference JS docs live in the docs/website repo today, as is also the case for all other languages now aside from Go (which we're proposing to move soon too).

We can begin that process now as I believe everyone is happy with the state of these docs. I'll probably merge this so that there is something while the website docs are worked on but will remove these in another PR when that is done. Does that seem reasonable?

These docs will also need to be changed to meet the outline laid out here (linked to from the metrics docs issue on this repo).

Good to know. Thanks for the link.

cartermp · 2022-11-09T20:25:07Z

Yep, makes sense! I think that's a good process

dyladan · 2022-11-10T13:29:18Z

Lint expected to fail markdown link check until the sdk metrics docs are published. The link is correct

weyert added 2 commits October 25, 2022 15:54

docs: add Metrics documentation to project

82d602c

fix: pr reference

5b648ca

weyert marked this pull request as ready for review October 25, 2022 14:56

weyert requested a review from a team as a code owner October 25, 2022 14:56

weyert mentioned this pull request Oct 25, 2022

docs: add documentation about using Metrics API/SDK #3349

Closed

7 tasks

weyert commented Oct 25, 2022

View reviewed changes

style: update the Metrics documentation

8ccc7cf

weyert force-pushed the chore-add-metrics-docs branch from 426f1ed to 8ccc7cf Compare October 25, 2022 16:38

docs: improve links in Metrics docs

679a74a

legendecas approved these changes Oct 26, 2022

View reviewed changes

CHANGELOG.md Outdated Show resolved Hide resolved

weyert added 5 commits October 26, 2022 23:48

Merge branch 'main' into chore-add-metrics-docs

aa524f8

doc: fix regression

56ba624

doc: fix regression

4dbeca1

Merge branch 'main' into chore-add-metrics-docs

c4578f5

Merge branch 'main' into chore-add-metrics-docs

4bb2436

legendecas reviewed Nov 1, 2022

View reviewed changes

doc/metrics.md Outdated Show resolved Hide resolved

docs: update doc/metrics.md

4aecda7

Co-authored-by: Chengzhong Wu <legendecas@gmail.com>

pichlermarc approved these changes Nov 2, 2022

View reviewed changes

CHANGELOG.md Outdated Show resolved Hide resolved

doc/metrics.md Outdated Show resolved Hide resolved

doc/metrics.md Outdated Show resolved Hide resolved

doc/metrics.md Outdated Show resolved Hide resolved

CHANGELOG.md Outdated Show resolved Hide resolved

pichlermarc and others added 5 commits November 2, 2022 10:41

Merge branch 'main' into chore-add-metrics-docs

833bf10

Merge branch 'main' into chore-add-metrics-docs

c71c940

docs: update CHANGELOG.md

c460c96

Co-authored-by: Marc Pichler <marcpi@edu.aau.at>

docs: update docs based on feedback

bea8169

Co-authored-by: Marc Pichler <marcpi@edu.aau.at>

docs: Update doc/metrics.md

1940978

Co-authored-by: Marc Pichler <marcpi@edu.aau.at>

weyert commented Nov 2, 2022

View reviewed changes

Skip localhost links in docs

0b7b488

vmarchaud approved these changes Nov 3, 2022

View reviewed changes

pichlermarc reviewed Nov 4, 2022

View reviewed changes

package.json Outdated Show resolved Hide resolved

dyladan added 3 commits November 4, 2022 08:53

Skip localhost links

647b0a4

Merge branch 'main' into chore-add-metrics-docs

54a6a99

Skip only certain links

b6f5963

dyladan force-pushed the chore-add-metrics-docs branch from c76991f to b6f5963 Compare November 8, 2022 20:31

dyladan approved these changes Nov 8, 2022

View reviewed changes

use api instead of api-metrics

9d59ad2

pichlermarc approved these changes Nov 9, 2022

View reviewed changes

Merge branch 'main' into chore-add-metrics-docs

8e1a15f

Fix documentation links

8047524

Fix api ref link

f227c73

dyladan merged commit 74e39c7 into open-telemetry:main Nov 10, 2022

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

docs: add Metrics documentation to project #3360

docs: add Metrics documentation to project #3360

weyert commented Oct 25, 2022 •

edited

codecov bot commented Oct 25, 2022 •

edited

weyert left a comment

weyert left a comment

linux-foundation-easycla bot commented Oct 25, 2022 •

edited

legendecas left a comment

dyladan commented Nov 1, 2022

dyladan commented Nov 1, 2022

weyert commented Nov 1, 2022

cartermp commented Nov 1, 2022

pichlermarc left a comment

weyert left a comment •

edited

dyladan commented Nov 8, 2022

pichlermarc left a comment

cartermp commented Nov 9, 2022

legendecas commented Nov 9, 2022 •

edited

cartermp commented Nov 9, 2022

dyladan commented Nov 9, 2022

cartermp commented Nov 9, 2022

dyladan commented Nov 10, 2022

docs: add Metrics documentation to project #3360

docs: add Metrics documentation to project #3360

Conversation

weyert commented Oct 25, 2022 • edited

Which problem is this PR solving?

Short description of the changes

Type of change

How Has This Been Tested?

Checklist:

codecov bot commented Oct 25, 2022 • edited

Codecov Report

weyert left a comment

Choose a reason for hiding this comment

weyert left a comment

Choose a reason for hiding this comment

linux-foundation-easycla bot commented Oct 25, 2022 • edited

legendecas left a comment

Choose a reason for hiding this comment

dyladan commented Nov 1, 2022

dyladan commented Nov 1, 2022

weyert commented Nov 1, 2022

cartermp commented Nov 1, 2022

pichlermarc left a comment

Choose a reason for hiding this comment

weyert left a comment • edited

Choose a reason for hiding this comment

dyladan commented Nov 8, 2022

pichlermarc left a comment

Choose a reason for hiding this comment

cartermp commented Nov 9, 2022

legendecas commented Nov 9, 2022 • edited

cartermp commented Nov 9, 2022

dyladan commented Nov 9, 2022

cartermp commented Nov 9, 2022

dyladan commented Nov 10, 2022

weyert commented Oct 25, 2022 •

edited

codecov bot commented Oct 25, 2022 •

edited

linux-foundation-easycla bot commented Oct 25, 2022 •

edited

weyert left a comment •

edited

legendecas commented Nov 9, 2022 •

edited