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

Documentation Tracking Issue #775

Closed
5 of 9 tasks
arielvalentin opened this issue May 26, 2021 · 6 comments
Closed
5 of 9 tasks

Documentation Tracking Issue #775

arielvalentin opened this issue May 26, 2021 · 6 comments
Labels

Comments

@arielvalentin
Copy link
Contributor

arielvalentin commented May 26, 2021

Summary

This issue is an action item outcome of the SIG meeting on 2021-05-25

There are several requests for documentation to this project by both end users and contributors. As we are ready to work on tasks they may merit further exploration and discussion in sub-issues.

Issues and Tasks

@fbogsany
Copy link
Contributor

fbogsany commented May 26, 2021

@arielvalentin
Copy link
Contributor Author

@robbkidd Here is a list of items we brainstormed as part of the more comprehensive guide:

  • events
  • set_attributes vs add_attributes
  • semantic conventions
  • in_span helper vs API/SDK specification methods
  • configuring exporters
  • choosing a span processor
  • error handling
  • logging
  • context propagation
  • customizing dependencies/more specific instrumentation config
  • shared context attributes
  • baggage
  • untraced
  • sampling
  • resource attributes
  • SDK ENVIRONMENT VARIABLES
  • Metrics Reporter

fbogsany added a commit that referenced this issue Sep 22, 2021
* docs: Update the quick start guide

See #775

Co-authored-by: Robb Kidd <[email protected]>

* docs: @robbkidd PR feedback

* Update website_docs/quick_start.md

Co-authored-by: Francis Bogsanyi <[email protected]>

* Update website_docs/manual_instrumentation.md

Co-authored-by: Francis Bogsanyi <[email protected]>

* Update website_docs/quick_start.md

Co-authored-by: Francis Bogsanyi <[email protected]>

* Update website_docs/manual_instrumentation.md

Co-authored-by: Francis Bogsanyi <[email protected]>

* Update website_docs/quick_start.md

Co-authored-by: Francis Bogsanyi <[email protected]>

Co-authored-by: Robb Kidd <[email protected]>
Co-authored-by: Francis Bogsanyi <[email protected]>
fbogsany pushed a commit that referenced this issue Oct 13, 2021
- Moved "who's using" section to the website docs to increase visibility
- Added table of contents on the repo homepage

See #775
@plantfansam
Copy link
Contributor

Bug report template has been added, so I checked that off

@plantfansam
Copy link
Contributor

Updated otel website docs here open-telemetry/opentelemetry.io#1452. Probably would be good to automate this process in the opentelemetry.io repo 🤔

@ahayworth
Copy link
Contributor

Our configuration docs could be better - see open-telemetry/opentelemetry-ruby-contrib#88 (comment)

Copy link
Contributor

👋 This issue has been marked as stale because it has been open with no activity. You can: comment on the issue or remove the stale label to hold stale off for a while, add the keep label to hold stale off permanently, or do nothing. If you do nothing this issue will be closed eventually by the stale bot.

@github-actions github-actions bot added the stale label Apr 26, 2024
@github-actions github-actions bot closed this as not planned Won't fix, can't repro, duplicate, stale May 28, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

4 participants