Skip to content

Add opentelemetry.io docs #636

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

Closed

Conversation

austinlparker
Copy link
Member

Per open-telemetry/opentelemetry.io#472, we're mirroring the docs content on the website to each SIG. When a release occurs and these docs are updated, please make an issue or PR mirroring them to their appropriate location in the website repo (https://github.com/open-telemetry/opentelemetry.io/tree/main/content/en/docs/cpp).

@austinlparker austinlparker requested a review from a team March 29, 2021 17:16
@codecov
Copy link

codecov bot commented Mar 29, 2021

Codecov Report

Merging #636 (0aeea99) into main (9fa6bd5) will decrease coverage by 0.01%.
The diff coverage is n/a.

Impacted file tree graph

@@            Coverage Diff             @@
##             main     #636      +/-   ##
==========================================
- Coverage   94.49%   94.47%   -0.02%     
==========================================
  Files         197      197              
  Lines        9130     9130              
==========================================
- Hits         8627     8626       -1     
- Misses        503      504       +1     
Impacted Files Coverage Δ
...include/opentelemetry/sdk/common/circular_buffer.h 97.87% <0.00%> (-2.13%) ⬇️


| Tracing | Metrics | Logging |
| ------- | ------- | ------- |
| Pre-Alpha | Pre-Alpha | Not Yet Implemented |
Copy link
Member

Choose a reason for hiding this comment

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

nit - we do have logging api/sdk pre-alpha release.

Copy link
Contributor

Choose a reason for hiding this comment

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

And I think Metrics should be "Not Yet Implemented".

## Further Reading

- [OpenTelemetry for C++ on GitHub](https://github.com/open-telemetry/opentelemetry-cpp)
- [Examples](https://github.com/open-telemetry/opentelemetry-cpp/tree/main/examples)
Copy link
Member

Choose a reason for hiding this comment

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

@reyang
Copy link
Member

reyang commented Mar 29, 2021

@austinlparker would it be okay to put the @open-telemetry/cpp-maintainers as the "CODEOWNER" of this folder https://github.com/open-telemetry/opentelemetry.io/tree/main/content/en/docs/cpp? In this way we don't have to duplicate the contents in this repo.

I can update the OTel C++ release process and put something like "for each release, update the opentelemetry.io docs".

@reyang
Copy link
Member

reyang commented Mar 29, 2021

I've submitted a PR open-telemetry/opentelemetry.io#505. Once it is merged, I'll update the release process doc https://github.com/open-telemetry/opentelemetry-cpp/blob/main/RELEASING.md then we can close this PR.

@reyang reyang added the pr:do-not-merge This PR is not ready to be merged. label Mar 29, 2021
Copy link
Member

@reyang reyang left a comment

Choose a reason for hiding this comment

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

I wish to explore if we could avoid duplicating docs. Mirroring the docs will create problem since we don't have the same CI rule between the OTel C++ and opentelemetry.io repo.

@austinlparker
Copy link
Member Author

I'm trying to avoid mirroring by making this be the authoritative source - my goal is to have a github action that will push these changes to the website each release.

@austinlparker
Copy link
Member Author

Unfortunately this is one of those things where everyone wants to do this slightly differently :|

@reyang
Copy link
Member

reyang commented Mar 29, 2021

I'm trying to avoid mirroring by making this be the authoritative source - my goal is to have a github action that will push these changes to the website each release.

This would be great!

@reyang
Copy link
Member

reyang commented Mar 29, 2021

@austinlparker I'm closing this PR as a result of #639.
If there is a way to automatically publish doc from this repo to opentelemetry.io (so we can keep all C++ related docs here), please let us know and we're happy to do it.

@reyang reyang closed this Mar 29, 2021
@reyang reyang added the documentation Improvements or additions to documentation label Mar 29, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation pr:do-not-merge This PR is not ready to be merged.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants