Skip to content

Commit 334d421

Browse files
chalinfbogsany
andauthored
[website_docs] Use console code-block style, and spellcheck (#1024)
Contributes to open-telemetry/opentelemetry.io#948 and open-telemetry/opentelemetry.io#949. /cc @austinlparker Co-authored-by: Francis Bogsanyi <[email protected]>
1 parent cf57e81 commit 334d421

File tree

1 file changed

+9
-9
lines changed

1 file changed

+9
-9
lines changed

website_docs/getting_started.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
title: "Getting Started"
2+
title: Getting Started
33
weight: 1
44
---
55

@@ -50,23 +50,23 @@ Now that you have setup your application to perform tracing, you'll need to conf
5050

5151
### Exporting Traces
5252

53-
The following section assumes you are new to OpenTelemetry or do not currently use a vendor that supports distributed tracing using OTLP. Please refer to your vendor's product documentation if you would like to export your traces to a vendor for analysis and vizualization.
53+
The following section assumes you are new to OpenTelemetry or do not currently use a vendor that supports distributed tracing using OTLP. Please refer to your vendor's product documentation if you would like to export your traces to a vendor for analysis and visualization.
5454

55-
For the purposes of this tutorial you will configure an OpenTelemetry collector that will receive the traces and vizualize them using Jaeger or Zipkin UI.
55+
For the purposes of this tutorial you will configure an OpenTelemetry collector that will receive the traces and visualize them using Jaeger or Zipkin UI.
5656

5757
First, start up an example system:
5858

59-
```bash
60-
$> git clone [email protected]:open-telemetry/opentelemetry-ruby.git; \
59+
```console
60+
$ git clone [email protected]:open-telemetry/opentelemetry-ruby.git; \
6161
cd open-telemetry-ruby/examples/otel-collector; \
6262
docker-compose up -d
6363
```
6464

6565
Next, you'll have to let the SDK know where the collector endpoint is to receive traces.
6666
Set the [`OTEL_EXPORTER_OTLP_ENDPOINT`][sdk-env] environment variable to `http://0.0.0.0:4318`:
6767

68-
```bash
69-
export OTEL_EXPORTER_OTLP_ENDPOINT=http://0.0.0.0:4318
68+
```console
69+
$ export OTEL_EXPORTER_OTLP_ENDPOINT=http://0.0.0.0:4318
7070
```
7171

7272
Now, start up your application and perform a few operations to generate tracing data, e.g. navigate around your web app or kick off background tasks.
@@ -75,9 +75,9 @@ Lastly, open a browser and navigate to the [Jaeger UI](http://localhost:16686) o
7575

7676
### Achievement Unlocked: Tracing Enabled
7777

78-
Adding tracing to a single service is a great first step and although auto-instrumenation provides quite a bit of insight on its own, OpenTelemetry provides a few more features that will allow you gain even deeper insights!
78+
Adding tracing to a single service is a great first step and although auto-instrumentation provides quite a bit of insight on its own, OpenTelemetry provides a few more features that will allow you gain even deeper insights!
7979

80-
[Context Propagation][context-propagation] is perhaps one of the most powerful concepts in OpenTelemetry because it will upgrade your single service trace into a _distributed trace_, which makes it possible for OpenTelemetry vendors to visualize a request from end-to-end accross process and network boundaries.
80+
[Context Propagation][context-propagation] is perhaps one of the most powerful concepts in OpenTelemetry because it will upgrade your single service trace into a _distributed trace_, which makes it possible for OpenTelemetry vendors to visualize a request from end-to-end across process and network boundaries.
8181

8282
[Span Events][events] allow you to add a human-readable message on a span that represents "something happening" during its lifetime.
8383

0 commit comments

Comments
 (0)