Skip to content

Commit a09eff6

Browse files
jaydelucajack-berg
andauthored
Reference configuration documentation on opentelemetry.io (#6491)
Co-authored-by: jack-berg <[email protected]>
1 parent cbac202 commit a09eff6

File tree

3 files changed

+9
-389
lines changed

3 files changed

+9
-389
lines changed

CONTRIBUTING.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -183,6 +183,11 @@ in the guide for exceptions to the Javadoc requirement.
183183
* Our javadoc is available via [
184184
javadoc.io}(https://javadoc.io/doc/io.opentelemetry/opentelemetry-api)
185185

186+
### SDK Configuration Documentation
187+
188+
All changes to the SDK configuration options or autoconfigure module should be documented on
189+
[opentelemetry.io](https://opentelemetry.io/docs/languages/java/configuration/).
190+
186191
### AutoValue
187192

188193
* Use [AutoValue](https://github.com/google/auto/tree/master/value), when possible, for any new

docs/sdk-configuration.md renamed to docs/sdk-configuration-design.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,8 @@
11
# 🚨 Archival Use Only! 🚨
22
> This is a historical design document and is not updated with evolving APIs. For up-to-date
33
> examples of SDK configuration see the
4-
> [documentation](https://opentelemetry.io/docs/java/manual_instrumentation/).
4+
> [manual instrumentation documentation](https://opentelemetry.io/docs/languages/java/instrumentation/)
5+
> and the [SDK configuration documentation](https://opentelemetry.io/docs/languages/java/configuration/).
56
> This document is maintained here for historical purposes only, and it is intended to
67
> help future readers to understand the rationale behind certain design decisions.
78

0 commit comments

Comments
 (0)