Updated dead links in glossary (#509)

* Update glossary.md * Update glossary.md * Update glossary.md * Update glossary.md * Update _index.md * Update _index.md * Added logo * Adde image alt text and logo * Added alt text and content edit * added alt text * Added alt text * added logo alt text * Improved content * added alt text * Added logo alt text
open-telemetry · Apr 6, 2021 · b4cf044 · b4cf044
1 parent 0c736a7
commit b4cf044
Show file tree

Hide file tree

Showing 11 changed files with 28 additions and 23 deletions.
diff --git a/content/en/_index.md b/content/en/_index.md
@@ -8,7 +8,7 @@ title: "OpenTelemetry"
       <img class="card-img-top mx-auto" src="/img/logos/opentelemetry-stacked-color.png">
       <div class="card-body">
         <h3 class="card-title text-left">An observability framework for cloud-native software.</h3>
-        <p class="card-text text-left"><small>OpenTelemetry is a collection of tools, APIs, and SDKs. You use it to instrument, generate, collect, and export telemetry data (metrics, logs, and traces) for analysis in order to understand your software's performance and behavior.</small></p>
+        <p class="card-text text-left"><small>OpenTelemetry is a collection of tools, APIs, and SDKs. You can use it to instrument, generate, collect, and export telemetry data (metrics, logs, and traces) for analysis in order to understand your software's performance and behavior.</small></p>
       </div>
     </div>
   <br/>

diff --git a/content/en/community/_index.md b/content/en/community/_index.md
@@ -1,8 +1,10 @@
 ---
-title: Community
+title: "Community"
+linkTitle: "Community"
 menu:
   main:
     weight: 40
+    pre: <i class="fas fa-users"></i>
 ---
 
 {{% blocks/section color="dark" %}}

diff --git a/content/en/docs/_index.md b/content/en/docs/_index.md
@@ -1,5 +1,6 @@
 ---
 title: "Documentation"
+
 aliases:
   - /csharp/
   - /csharp/metrics/
@@ -19,9 +20,11 @@ aliases:
   - /ruby/
   - /ruby/metrics/
   - /ruby/tracing/
+
 menu:
   main:
     weight: 10
+    pre: <i class='fas fa-book'></i>
 ---
 
 OpenTelemetry is a set of APIs, SDKs, tooling and integrations that are
@@ -30,7 +33,7 @@ metrics, and logs. The OpenTelemetry documentation is intended to broadly cover
 key terms, concepts, and instructions on how to use OpenTelemetry in your
 software.
 
-<img src="https://raw.github.com/open-telemetry/opentelemetry.io/main/iconography/Reference_Architecture.svg"></img>
+<img src="https://raw.github.com/open-telemetry/opentelemetry.io/main/iconography/Reference_Architecture.svg" alt="Implementation of the OpenTelemetry Reference Architecture "></img>
 
 OpenTelemetry provides an implementation of all of its components as well as a
 reference architecture. The project is flexible and extensible to support a

diff --git a/content/en/docs/collector/_index.md b/content/en/docs/collector/_index.md
@@ -3,23 +3,23 @@ title: "Collector"
 linkTitle: "Collector"
 weight: 10
 description: >
-  <img width="35" src="https://raw.github.com/open-telemetry/opentelemetry.io/main/iconography/32x32/Collector.svg"></img>
+  <img width="35" src="https://raw.github.com/open-telemetry/opentelemetry.io/main/iconography/32x32/Collector.svg" alt="Collector logo"></img>
   Vendor-agnostic way to receive, process and export telemetry data
 ---
 
-<img src="https://raw.github.com/open-telemetry/opentelemetry.io/main/iconography/Otel_Collector.svg"></img>
+<img src="https://raw.github.com/open-telemetry/opentelemetry.io/main/iconography/Otel_Collector.svg" alt="Otel-Collector diagram with Jaeger, OTLP and Prometheus integration"></img>
 
 The OpenTelemetry Collector offers a vendor-agnostic implementation on how to
 receive, process and export telemetry data. It removes the need to run,
-operate, and maintain multiple agents/collectors in order to support
+operate, and maintain multiple agents/collectors. This works with improved scalability and supports
 open-source observability data formats (e.g. Jaeger, Prometheus, Fluent Bit,
 etc.) sending to one or more open-source or commercial back-ends. The Collector
 is the default location instrumentation libraries export their telemetry data.
 
 Objectives:
 
-- Usable: Reasonable default configuration, supports popular protocols, runs and collects out of the box.
-- Performant: Highly stable and performant under varying loads and configurations.
-- Observable: An exemplar of an observable service.
-- Extensible: Customizable without touching the core code.
-- Unified: Single codebase, deployable as an agent or collector with support for traces, metrics, and logs (future).
+- *Usability*: Reasonable default configuration, supports popular protocols, runs and collects out of the box.
+- *Performance*: Highly stable and performant under varying loads and configurations.
+- *Observability*: An exemplar of an observable service.
+- *Extensibility*: Customizable without touching the core code.
+- *Unification*: Single codebase, deployable as an agent or collector with support for traces, metrics, and logs (future).
diff --git a/content/en/docs/concepts/glossary.md b/content/en/docs/concepts/glossary.md
@@ -19,23 +19,23 @@ others. This page captures terminology used in the project and what it means.
   `Tracing` `Data Source`.
 - **[Attributes](https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/common/common.md#attributes):**
   Used by the `Tracing` `Data Source` to attach name/value pairs to a `Span`.
-- **[Baggage](https://opentelemetry.io/docs/concepts/overview/#baggage):** A
+- **[Baggage](https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/overview.md#baggage-signal):** A
   mechanism for propagating name/value pairs to help establish a causal
   relationship between events and services.
 - **Client Library:** See `Instrumented Library`.
-- **[Collector](https://opentelemetry.io/docs/concepts/overview/#collector):**
+- **[Collector](https://opentelemetry.io/docs/collector/):**
   A vendor-agnostic implementation on how to receive, process, and export
   telemetry data. A single binary that can be deployed as an agent or gateway.
 - **Contrib:** Several `Instrumentation Libraries` and the `Collector` offer a set
   of core capabilities as well as a dedicated contrib repository for non-core
   capabilities including vendor `Exporters`.
 - **[Context
-  Propagation](https://opentelemetry.io/docs/concepts/overview/#context-propagation):**
+  Propagation](https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/overview.md#context-propagation):**
   Allows all `Data Sources` to share an underlying context mechanism for storing
   state and accessing data across the lifespan of a `Transaction`.
 - **[DAG](https://en.wikipedia.org/wiki/Directed_acyclic_graph):** Directed Acyclic Graph.
 - **[Data
-  Source](https://opentelemetry.io/docs/concepts/overview/#data-sources):** One
+  Source](https://github.com/open-telemetry/opentelemetry.io/blob/main/content/en/docs/concepts/data-sources.md):** One
   of `Traces`, `Metrics` or `Logs`.
 - **Dimension:** See `Label`.
 - **[Distributed
@@ -50,7 +50,7 @@ others. This page captures terminology used in the project and what it means.
   [Instrumentation
   Libraries](https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/glossary.md#exporter-library)
   and the
-  [Collector](https://opentelemetry.io/docs/collector/configuration/#exporters).
+  [Collector](https://github.com/open-telemetry/opentelemetry.io/blob/main/content/en/docs/collector/configuration.md#basics).
   Exporters can be push or pull based.
 - **[Field](https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/logs/data-model.md#field-kinds):**
   name/value pairs added to `Log Records` (similar to `Attributes` for `Spans` and

diff --git a/content/en/docs/erlang/_index.md b/content/en/docs/erlang/_index.md
@@ -2,7 +2,7 @@
 title: "Erlang/Elixir"
 weight: 14
 description: >
-  <img width="35" src="https://raw.github.com/open-telemetry/opentelemetry.io/main/iconography/32x32/Elixir_SDK.svg"></img>
+  <img width="35" src="https://raw.github.com/open-telemetry/opentelemetry.io/main/iconography/32x32/Elixir_SDK.svg" alt="Erlang logo"></img>
   A language-specific implementation of OpenTelemetry in Erlang/Elixir.
 ---
 

diff --git a/content/en/docs/java/_index.md b/content/en/docs/java/_index.md
@@ -2,7 +2,7 @@
 title: "Java"
 weight: 18
 description: >
-  <img width="35" src="https://raw.github.com/open-telemetry/opentelemetry.io/main/iconography/32x32/Java_SDK.svg"></img>
+ <img width="35" src="https://raw.github.com/open-telemetry/opentelemetry.io/main/iconography/32x32/Java_SDK.svg" alt="Java logo"></img>
   A language-specific implementation of OpenTelemetry in Java.
 ---
 

diff --git a/content/en/docs/js/_index.md b/content/en/docs/js/_index.md
@@ -2,7 +2,7 @@
 title: "Javascript"
 weight: 20
 description: >
-  <img width="35" src="https://raw.github.com/open-telemetry/opentelemetry.io/main/iconography/32x32/JS_SDK.svg"></img>
+  <img width="35" src="https://raw.github.com/open-telemetry/opentelemetry.io/main/iconography/32x32/JS_SDK.svg" alt="JavaScript logo"></img>
   A language-specific implementation of OpenTelemetry in JavaScript (for Node.JS & the browser).
 ---
 

diff --git a/content/en/docs/js/instrumentation_examples.md b/content/en/docs/js/instrumentation_examples.md
@@ -3,15 +3,15 @@ title: "Instrumentation Examples"
 weight: 4
 ---
 
-Here are Some of the resources for Opentelemetry Instrumentation Examples
+Here are some resources for Opentelemetry Instrumentation Examples
 
 ## Community Resources
 
 ### nodejs-opentelemetry-tempo
 
 Project demonstrating Complete Observability Stack utilizing [Prometheus](https://prometheus.io/), [Loki](https://grafana.com/oss/loki/) (_For distributed logging_), [Tempo](https://grafana.com/oss/tempo/) (_For Distributed tracing, this basically uses Jaeger Internally_), [Grafana](https://grafana.com/grafana/) for **NodeJs** based applications (_With OpenTelemetry auto / manual Instrumentation_) involving microservices with DB interactions.
 
-Checkout [nodejs-opentelemetry-tempo](https://github.com/mnadeem/nodejs-opentelemetry-tempo) and get started
+Checkout [nodejs-opentelemetry-tempo](https://github.com/mnadeem/nodejs-opentelemetry-tempo) and get started!
 
 ````bash
 docker-compose up --build

diff --git a/content/en/docs/net/_index.md b/content/en/docs/net/_index.md
@@ -2,7 +2,7 @@
 title: ".NET"
 weight: 12
 description: >
-  <img width="35" src="https://raw.github.com/open-telemetry/opentelemetry.io/main/iconography/32x32/.NET.svg"></img>
+  <img width="35" src="https://raw.github.com/open-telemetry/opentelemetry.io/main/iconography/32x32/.NET.svg" alt="NET logo"></img>
   A language-specific implementation of OpenTelemetry in .NET.
 ---
 

diff --git a/content/en/docs/ruby/_index.md b/content/en/docs/ruby/_index.md
@@ -2,7 +2,7 @@
 title: "Ruby"
 weight: 24
 description: >
-  <img width="35" src="https://raw.github.com/open-telemetry/opentelemetry.io/main/iconography/32x32/Ruby_SDK.svg"></img>
+  <img width="35" src="https://raw.github.com/open-telemetry/opentelemetry.io/main/iconography/32x32/Ruby_SDK.svg" alt="Ruby logo"></img>
   A language-specific implementation of OpenTelemetry in Ruby.
 ---