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

Update README to include documentation link #710

Merged

Conversation

dyladan
Copy link
Member

@dyladan dyladan commented Jan 20, 2020

Short description of the changes

  • Update README to point to the newly operational documentation link.
  • Update README to keep links in a central location at the bottom
  • Update README to differentiate between Application Owners and Library Authors

@dyladan dyladan changed the title chore: update readme.md to include documentation link Update README to include documentation link Jan 20, 2020
Copy link
Member

@OlivierAlbertini OlivierAlbertini left a comment

Choose a reason for hiding this comment

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

LGTM

@mayurkale22
Copy link
Member

mayurkale22 commented Jan 20, 2020

You We should update the documentation link in opentelemetry.io => js => api-reference (https://opentelemetry.io/docs/js/tracing/#api-reference).

@mayurkale22 mayurkale22 added the document Documentation-related label Jan 20, 2020
@mayurkale22
Copy link
Member

I did it here open-telemetry/opentelemetry.io#97 :)

@codecov-io
Copy link

codecov-io commented Jan 21, 2020

Codecov Report

Merging #710 into master will increase coverage by 1.6%.
The diff coverage is 100%.

@@            Coverage Diff            @@
##           master     #710     +/-   ##
=========================================
+ Coverage   91.03%   92.64%   +1.6%     
=========================================
  Files         224      228      +4     
  Lines       10452    10343    -109     
  Branches      955      941     -14     
=========================================
+ Hits         9515     9582     +67     
+ Misses        937      761    -176
Impacted Files Coverage Δ
...s/opentelemetry-tracing/src/BasicTracerRegistry.ts 100% <ø> (ø) ⬆️
...lemetry-core/test/trace/globaltracer-utils.test.ts 96.96% <ø> (ø) ⬆️
...-metrics/test/export/ConsoleMetricExporter.test.ts 100% <ø> (ø) ⬆️
...pentelemetry-core/src/metrics/NoopMeterRegistry.ts 100% <100%> (ø)
.../opentelemetry-core/test/metrics/NoopMeter.test.ts 97.29% <100%> (+0.07%) ⬆️
...emetry-exporter-prometheus/test/prometheus.test.ts 98.6% <100%> (ø) ⬆️
packages/opentelemetry-tracing/src/Tracer.ts 98.38% <100%> (-0.03%) ⬇️
...ackages/opentelemetry-metrics/src/MeterRegistry.ts 100% <100%> (ø)
packages/opentelemetry-core/src/trace/NoopSpan.ts 100% <100%> (ø) ⬆️
...s/opentelemetry-metrics/test/MeterRegistry.test.ts 100% <100%> (ø)
... and 61 more

@mayurkale22 mayurkale22 merged commit 104ce02 into open-telemetry:master Jan 21, 2020
@dyladan dyladan deleted the readme-doc-link branch January 22, 2020 13:18
pichlermarc pushed a commit to dynatrace-oss-contrib/opentelemetry-js that referenced this pull request Dec 15, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
document Documentation-related
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants