Nit fixes to Resource docs (#1796)

Co-authored-by: Zhongyang Wu <[email protected]>

Author: cijothomas

.cspell.json

@@ -52,6 +52,7 @@
         "reqwest",
         "runtimes",
         "rustc",
+        "shoppingcart",
         "Tescher",
         "tracerprovider",
         "Zhongyang",

opentelemetry-sdk/src/resource/env.rs

@@ -10,11 +10,9 @@ use std::time::Duration;
 const OTEL_RESOURCE_ATTRIBUTES: &str = "OTEL_RESOURCE_ATTRIBUTES";
 const OTEL_SERVICE_NAME: &str = "OTEL_SERVICE_NAME";
 
-/// Resource detector implements ResourceDetector and is used to extract
-/// general SDK configuration from environment.
-///
-/// See
-/// [semantic conventions](https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/resource/sdk.md#specifying-resource-information-via-an-environment-variable)
+/// EnvResourceDetector extract resource from environment variable
+/// `OTEL_RESOURCE_ATTRIBUTES`. See [OpenTelemetry Resource
+/// Spec](https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/resource/sdk.md#specifying-resource-information-via-an-environment-variable)
 /// for details.
 #[derive(Debug)]
 pub struct EnvResourceDetector {

opentelemetry-sdk/src/resource/mod.rs

@@ -18,7 +18,8 @@
 //! - [`EnvResourceDetector`] - detect resource from environmental variables.
 //! - [`TelemetryResourceDetector`] - detect telemetry SDK's information.
 //!
-//! The OS and Process resource detectors are now packaged separately in the `opentelemetry-resource-detector` [crate](https://github.com/open-telemetry/opentelemetry-rust-contrib/tree/main/opentelemetry-resource-detectors).
+//! The OS and Process resource detectors are packaged separately in the
+//! [`opentelemetry-resource-detector` crate](https://github.com/open-telemetry/opentelemetry-rust-contrib/tree/main/opentelemetry-resource-detectors).
 mod env;
 mod telemetry;
 
@@ -208,7 +209,7 @@ impl Resource {
         self.inner.attrs.is_empty()
     }
 
-    /// Gets an iterator over the attributes of this resource, sorted by key.
+    /// Gets an iterator over the attributes of this resource.
     pub fn iter(&self) -> Iter<'_> {
         Iter(self.inner.attrs.iter())
     }

opentelemetry-sdk/src/resource/telemetry.rs

@@ -10,9 +10,8 @@ use std::time::Duration;
 /// - The language of the telemetry SDK(`telemetry.sdk.language`). It will be `rust` for this SDK.
 /// - The version of the telemetry SDK(`telemetry.sdk.version`). It will be current `opentelemetry_sdk` crate version.
 ///
-/// Note that the `telemetry.auto.version` is not provided as of now.
 ///
-/// See [semantic conventions](https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/resource/semantic_conventions/README.md#telemetry-sdk) for details.
+/// See [semantic conventions](https://github.com/open-telemetry/semantic-conventions/blob/main/docs/resource/README.md#telemetry-sdk) for details.
 #[derive(Debug)]
 pub struct TelemetryResourceDetector;