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.

Sign up for GitHub

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

Jump to bottom

Reference configuration documentation on opentelemetry.io #6491

Merged
merged 3 commits into from
Jun 24, 2024
Merged

Reference configuration documentation on opentelemetry.io #6491

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
82a4bf0
remove autoconfigure docs and point to doc site, update contributing …
jaydeluca Jun 2, 2024
2d46e00
Update sdk-extensions/autoconfigure/README.md
jaydeluca Jun 3, 2024
e1f82ef
rename sdk configuration design filename
jaydeluca Jun 17, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -183,6 +183,11 @@ in the guide for exceptions to the Javadoc requirement.
* Our javadoc is available via [
javadoc.io}(https://javadoc.io/doc/io.opentelemetry/opentelemetry-api)

### SDK Configuration Documentation

All changes to the SDK configuration options or autoconfigure module should be documented on
[opentelemetry.io](https://opentelemetry.io/docs/languages/java/configuration/).

### AutoValue

* Use [AutoValue](https://github.com/google/auto/tree/master/value), when possible, for any new
Expand Down
3 changes: 2 additions & 1 deletion docs/sdk-configuration.md → docs/sdk-configuration-design.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
# 🚨 Archival Use Only! 🚨
> This is a historical design document and is not updated with evolving APIs. For up-to-date
> examples of SDK configuration see the
> [documentation](https://opentelemetry.io/docs/java/manual_instrumentation/).
> [manual instrumentation documentation](https://opentelemetry.io/docs/languages/java/instrumentation/)
> and the [SDK configuration documentation](https://opentelemetry.io/docs/languages/java/configuration/).
> This document is maintained here for historical purposes only, and it is intended to
> help future readers to understand the rationale behind certain design decisions.

Expand Down
Loading
Loading