[DOC] Fix minor issues in Span profiles doc (#3099)

* Fix minor issues in Span profiles doc * Update _index.md
grafana · Mar 18, 2024 · 16e76e9 · 16e76e9
1 parent 4e4192b
commit 16e76e9
Show file tree

Hide file tree

Showing 4 changed files with 16 additions and 18 deletions.
diff --git a/docs/sources/configure-client/trace-span-profiles/_index.md b/docs/sources/configure-client/trace-span-profiles/_index.md
@@ -1,13 +1,14 @@
 ---
-title: "Linking tracing and profiling with span profiles"
+title: "Linking tracing and profiling with Span Profiles"
 menuTitle: "Linking traces and profiles"
 description: "Learn how to configure the client to Link tracing and profiling with span profiles."
 weight: 35
 ---
 
-# Linking tracing and profiling with span profiles
+# Linking tracing and profiling with Span Profiles
 
-Span Profiles are a powerful feature that further enhances the value of continuous profiling. Span Profiles offer a novel approach to profiling by providing detailed insights into specific execution scopes of applications, moving beyond the traditional system-wide analysis to offer a more dynamic, focused analysis of individual requests or trace spans. 
+Span Profiles are a powerful feature that further enhances the value of continuous profiling.
+Span Profiles offer a novel approach to profiling by providing detailed insights into specific execution scopes of applications, moving beyond the traditional system-wide analysis to offer a more dynamic, focused analysis of individual requests or trace spans.
 
 This method enhances understanding of application behavior by directly linking traces with profiling data, enabling engineering teams to pinpoint and resolve performance bottlenecks with precision.
 
@@ -24,6 +25,6 @@ Get started:
   - Go: [Span profiles with Traces to profiles (Go)]({{< relref "./go-span-profiles" >}})
   - Java: [Span profiles with Traces to profiles (Java)]({{< relref "./java-span-profiles" >}})
   - Ruby: [Span profiles with Traces to profiles (Ruby)]({{< relref "./ruby-span-profiles" >}})
-- Grafana Tempo: Visualize and analyze Span Profiles within the Grafana Tempo UI
+- Grafana Tempo: Visualize and analyze Span Profiles within the Grafana using a Tempo data source.
 
-To learn more check out our product announcement blog introducing the [span profiles feature](/blog/2024/02/06/combining-tracing-and-profiling-for-enhanced-observability-introducing-span-profiles/)
+To learn more, check out our product announcement blog: [Introducing Span Profiles](/blog/2024/02/06/combining-tracing-and-profiling-for-enhanced-observability-introducing-span-profiles/).
diff --git a/docs/sources/configure-client/trace-span-profiles/go-span-profiles.md b/docs/sources/configure-client/trace-span-profiles/go-span-profiles.md
@@ -99,8 +99,7 @@ To learn how to set up Traces to profiles and view the span profiles, refer to [
 
 ## Examples
 
-Check out the [examples directory](https://github.com/grafana/pyroscope/tree/main/examples/tracing/tempo) in the Pyroscope GitHub repository to
-find a complete example application that demonstrates tracing integration features.
+Check out the [examples](https://github.com/grafana/pyroscope/tree/main/examples/tracing/tempo) directory for a complete demo application that shows tracing integration features.
 
 <!-- ## Using tracing exemplars manually
 

diff --git a/docs/sources/configure-client/trace-span-profiles/java-span-profiles.md b/docs/sources/configure-client/trace-span-profiles/java-span-profiles.md
@@ -11,7 +11,7 @@ weight: 100
 
 ## Before you begin
 
-Your applications must be instrumented for profiling and tracing before you can use span profiles. 
+Your applications must be instrumented for profiling and tracing before you can use span profiles.
 
 * Profiling: Your application must be instrumented with Pyroscopes Java client SDK. If you haven't done this yet, please refer to the [Java ()]({{< relref "../language-sdks/java" >}}) guide.
 * Tracing: Your application must be instrumented with OpenTelemetry traces. If you haven't done this yet, please refer to the [OpenTelemetry](https://opentelemetry.io/docs/java/getting-started/) guide.
@@ -29,9 +29,9 @@ link traces with the profiling data, and find resource usage for specific lines
 
 ## Configure the otel-profiling-java package
 
-To start collecting Span Profiles for your Java application, you need to include [otel-profiling-java](https://github.com/pyroscope-io/otel-profiling-java) in your code. 
+To start collecting Span Profiles for your Java application, you need to include [otel-profiling-java](https://github.com/pyroscope-io/otel-profiling-java) in your code.
 
-This package is a `TracerProvider` implementation, that labels profiling data with span IDs which makes it possible to query for span-specific profiling data in Grafana Tempo UI. 
+This package is a `TracerProvider` implementation, that labels profiling data with span IDs which makes it possible to query for span-specific profiling data in Grafana Tempo UI.
 
 ```shell
 java -jar ./build/libs/rideshare-1.0-SNAPSHOT.jar \
@@ -51,7 +51,7 @@ Next, you need to create and configure the tracer provider:
 implementation("io.pyroscope:otel:0.10.1.1")
 
 // obtain SdkTracerProviderBuilder
-SdkTracerProviderBuilder tpBuilder = ... 
+SdkTracerProviderBuilder tpBuilder = ...
 
 // Add PyroscopeOtelSpanProcessor to SdkTracerProviderBuilder
 PyroscopeOtelConfiguration pyroscopeTelemetryConfig = new PyroscopeOtelConfiguration.Builder()
@@ -96,5 +96,4 @@ The profile type or app must be selected for the query to be valid. Grafana does
 
 ## Examples
 
-Check out the [examples](https://github.com/grafana/pyroscope/tree/main/examples/tracing/tempo) directory in our repository to
-find a complete example application that demonstrates tracing integration features.
+Check out the [examples](https://github.com/grafana/pyroscope/tree/main/examples/tracing/tempo) directory for a complete demo application that shows tracing integration features.
diff --git a/docs/sources/configure-client/trace-span-profiles/ruby-span-profiles.md b/docs/sources/configure-client/trace-span-profiles/ruby-span-profiles.md
@@ -11,7 +11,7 @@ weight: 100
 
 ## Before you begin
 
-Your applications must be instrumented for profiling and tracing before you can use span profiles. 
+Your applications must be instrumented for profiling and tracing before you can use span profiles.
 
 * Profiling: Your application must be instrumented with Pyroscopes Ruby SDK. If you haven't done this yet, please refer to the [Ruby (push mode)]({{< relref "../language-sdks/ruby" >}}) guide.
 * Tracing: Your application must be instrumented with OpenTelemetry traces. If you haven't done this yet, please refer to the [OpenTelemetry](https://opentelemetry.io/docs/ruby/getting-started/) guide.
@@ -29,9 +29,9 @@ link traces with the profiling data, and find resource usage for specific lines
 
 ## Configure the otel-profiling-ruby package
 
-To start collecting Span Profiles for your Ruby application, you need to include [otel-profiling-ruby](https://github.com/pyroscope-io/otel-profiling-ruby) in your code. 
+To start collecting Span Profiles for your Ruby application, you need to include [otel-profiling-ruby](https://github.com/pyroscope-io/otel-profiling-ruby) in your code.
 
-This package is a `TracerProvider` implementation, that labels profiling data with span IDs which makes it possible to query for span-specific profiling data in Grafana Tempo UI. 
+This package is a `TracerProvider` implementation, that labels profiling data with span IDs which makes it possible to query for span-specific profiling data in Grafana Tempo UI.
 
 ```shell
 # Add to your Gemfile
@@ -75,5 +75,4 @@ The profile type or app must be selected for the query to be valid. Grafana does
 
 ## Examples
 
-Check out the [examples](https://github.com/grafana/pyroscope/tree/main/examples/tracing/tempo) directory in our repository to
-find a complete example application that demonstrates tracing integration features.
+Check out the [examples](https://github.com/grafana/pyroscope/tree/main/examples/tracing/tempo) directory for a complete demo application that shows tracing integration features.