Reference configuration documentation on opentelemetry.io (#6491)

Co-authored-by: jack-berg <[email protected]>
open-telemetry · Jun 24, 2024 · a09eff6 · a09eff6
1 parent cbac202
commit a09eff6
Show file tree

Hide file tree

Showing 3 changed files with 9 additions and 389 deletions.
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -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

diff --git a/docs/sdk-configuration.md → docs/sdk-configuration-design.md b/docs/sdk-configuration.md → docs/sdk-configuration-design.md
@@ -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.