Merge branch 'main' into distro-selection

open-telemetry · Jun 8, 2023 · 78b7383 · 78b7383
2 parents ebfc86c + e0a8552
commit 78b7383
Show file tree

Hide file tree

Showing 91 changed files with 625 additions and 223 deletions.
diff --git a/assets/scss/_styles_project.scss b/assets/scss/_styles_project.scss
@@ -10,7 +10,6 @@
     margin-top: 2rem;
     margin-bottom: 3rem;
     max-height: 12rem;
-    // max-width: 85%;
   }
 
   .td-box--white .container blockquote {
@@ -109,16 +108,12 @@
 } // TODO: propagate this fix to Docsy. Also class name should be prefixed with td
 
 // Adjust the spacing of page-meta and page-TOC (https://github.com/open-telemetry/opentelemetry.io/pull/354)
+// TODO: upstream
 .td-toc #TableOfContents {
   padding-top: 1rem;
 }
 
 .td-home {
-  .td-main {
-    // Remove the gap between the last block shortcode and the footer (on homepage)
-    flex-grow: 0;
-  }
-
   .cncf {
     text-align: center;
 
@@ -139,40 +134,6 @@
   }
 }
 
-.td-default, // E.g.: Homepage, Status, Search, 404; excludes navbar
-.td-section main, .td-page main, // Doc and blog main content without left/right navs
-.td-page-meta {
-  a:hover:not(.dropdown-item) {
-    text-decoration: underline;
-  }
-}
-
-.td-box--dark a,
-.td-box--primary a {
-  color: lighten($primary, 25%) !important; // TODO: upstream
-}
-
-.td-box--secondary a {
-  color: darken($primary, 25%) !important; // TODO: upstream
-}
-
-// Adjust anchors scroll snap (https://github.com/open-telemetry/opentelemetry.io/pull/348)
-@include media-breakpoint-up(md) {
-  h2[id],
-  h3[id],
-  h4[id],
-  h5[id] {
-    scroll-margin-top: 5rem;
-  }
-  h2[id]:before,
-  h3[id]:before,
-  h4[id]:before,
-  h5[id]:before {
-    margin-top: 0;
-    height: 0;
-  }
-}
-
 .o-banner {
   @include media-breakpoint-up(md) {
     width: 100%;
@@ -194,6 +155,7 @@
 .td-page-meta--child {
   display: none !important;
 }
+
 .otel-docs-spec {
   .td-page-meta--edit {
     display: none !important;
@@ -247,12 +209,8 @@
   }
 }
 
-.td-content pre.mermaid {
-  margin-block-end: 0;
+.otel-mermaid-max-width pre.mermaid {
   max-width: inherit;
-  svg {
-    height: auto;
-  }
 }
 
 .td-content img:not(.img-initial) {

diff --git a/content/en/blog/2023/end-user-q-and-a-03.md b/content/en/blog/2023/end-user-q-and-a-03.md
diff --git a/content/en/docs/collector/_index.md b/content/en/docs/collector/_index.md
@@ -1,9 +1,11 @@
 ---
 title: Collector
 description: Vendor-agnostic way to receive, process and export telemetry data.
-aliases: [/docs/collector/about]
+aliases:
+  - /docs/collector/about
+  - /docs/concepts/data-collection
 cascade:
-  collectorVersion: 0.78.0
+  collectorVersion: 0.79.0
 weight: 10
 ---
 

diff --git a/content/en/docs/collector/configuration.md b/content/en/docs/collector/configuration.md
@@ -9,8 +9,8 @@ spelling: cSpell:ignore oidc cfssl genkey initca cfssljson gencert
 
 Familiarity with the following pages is assumed:
 
-- [Data Collection concepts](/docs/concepts/data-collection/) in order to
-  understand the repositories applicable to the OpenTelemetry Collector.
+- [Data Collection concepts](../) in order to understand the repositories
+  applicable to the OpenTelemetry Collector.
 - [Security guidance](https://github.com/open-telemetry/opentelemetry-collector/blob/main/docs/security-best-practices.md)
 
 ## Basics

diff --git a/content/en/docs/collector/getting-started.md b/content/en/docs/collector/getting-started.md
@@ -321,7 +321,7 @@ terminal window as well.
 **Note:** The commands shown above demonstrate the process in a bash shell.
 These commands may vary slightly for other shells.
 
-[data collection]: /docs/concepts/data-collection/
+[data collection]: ../
 [deployment methods]: ../deployment/
 [readme.md]:
   https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/main/examples/demo

diff --git a/content/en/docs/concepts/data-collection.md b/content/en/docs/concepts/data-collection.md
diff --git a/content/en/docs/concepts/distributions.md b/content/en/docs/concepts/distributions.md
@@ -11,7 +11,7 @@ support multiple [signals](../signals). The reference implementation of
 OpenTelemetry is available as:
 
 - [Language-specific instrumentation libraries](../instrumentation)
-- [A Collector binary](../data-collection)
+- [A Collector binary](/docs/collector)
 
 From any reference implementation a distribution may be created.
 

diff --git a/content/en/docs/demo/architecture.md b/content/en/docs/demo/architecture.md
@@ -2,6 +2,7 @@
 title: Demo Architecture
 linkTitle: Architecture
 aliases: [/docs/demo/current_architecture]
+body_class: otel-mermaid-max-width
 ---
 
 **OpenTelemetry Demo** is composed of microservices written in different

diff --git a/content/en/docs/instrumentation/cpp/api.md b/content/en/docs/instrumentation/cpp/api.md
@@ -4,5 +4,5 @@ linkTitle: API
 redirect: https://opentelemetry-cpp.readthedocs.io/en/latest/
 manualLinkTarget: _blank
 _build: { render: link }
-weight: 50
+weight: 210
 ---
diff --git a/content/en/docs/instrumentation/cpp/examples.md b/content/en/docs/instrumentation/cpp/examples.md
@@ -3,5 +3,5 @@ title: Examples
 redirect: https://github.com/open-telemetry/opentelemetry-cpp/tree/main/examples
 manualLinkTarget: _blank
 _build: { render: link }
-weight: 60
+weight: 220
 ---
diff --git a/content/en/docs/instrumentation/cpp/exporters.md b/content/en/docs/instrumentation/cpp/exporters.md
@@ -1,6 +1,6 @@
 ---
 title: Exporters
-weight: 4
+weight: 50
 spelling: cSpell:ignore ostream jaegertracing millis chrono
 ---
 

diff --git a/content/en/docs/instrumentation/cpp/getting-started.md b/content/en/docs/instrumentation/cpp/getting-started.md
@@ -1,6 +1,6 @@
 ---
 title: Getting Started
-weight: 2
+weight: 10
 spelling: cSpell:ignore Bazel libcurl openssl xcode DBUILD DWITH helloworld tracestate
 spelling: cSpell:ignore traceparent devel
 ---

diff --git a/content/en/docs/instrumentation/cpp/manual.md b/content/en/docs/instrumentation/cpp/manual.md
@@ -1,7 +1,7 @@
 ---
 title: Manual Instrumentation
 linkTitle: Manual
-weight: 3
+weight: 30
 ---
 
 Manual instrumentation is the process of adding observability code to your

diff --git a/content/en/docs/instrumentation/erlang/api.md b/content/en/docs/instrumentation/erlang/api.md
@@ -4,5 +4,5 @@ linkTitle: API
 redirect: https://hexdocs.pm/opentelemetry_api/OpenTelemetry.html
 manualLinkTarget: _blank
 _build: { render: link }
-weight: 50
+weight: 210
 ---
diff --git a/content/en/docs/instrumentation/erlang/examples.md b/content/en/docs/instrumentation/erlang/examples.md
@@ -3,5 +3,5 @@ title: Examples
 redirect: https://github.com/open-telemetry/opentelemetry-erlang-contrib/tree/main/examples
 manualLinkTarget: _blank
 _build: { render: link }
-weight: 60
+weight: 220
 ---
diff --git a/...entation/erlang/getting-started/_index.md → ...instrumentation/erlang/getting-started.md b/...entation/erlang/getting-started/_index.md → ...instrumentation/erlang/getting-started.md
@@ -1,6 +1,6 @@
 ---
 title: Getting Started
-weight: 20
+weight: 10
 spelling: cSpell:ignore rebar relx stdlib bogons
 spelling: cSpell:ignore defmodule erts hipe Eshell erlang
 ---
@@ -287,9 +287,9 @@ when rendered in your tracing tool of choice.
 ### Next Steps
 
 Enrich your automatically generated instrumentation with
-[manual instrumentation](/docs/instrumentation/erlang/instrumentation) of your
-own codebase. This allows you to customize the observability data your
-application emits.
+[manual instrumentation](/docs/instrumentation/erlang/manual) of your own
+codebase. This allows you to customize the observability data your application
+emits.
 
 You'll also want to configure an appropriate exporter to
 [export your telemetry data](/docs/instrumentation/erlang/getting-started#exporting-to-the-opentelemetry-collector)

diff --git a/...instrumentation/erlang/instrumentation.md → .../en/docs/instrumentation/erlang/manual.md b/...instrumentation/erlang/instrumentation.md → .../en/docs/instrumentation/erlang/manual.md
@@ -1,5 +1,6 @@
 ---
-title: Instrumentation
+title: Manual
+aliases: [/docs/instrumentation/erlang/instrumentation]
 weight: 30
 ---
 

diff --git a/content/en/docs/instrumentation/erlang/propagation.md b/content/en/docs/instrumentation/erlang/propagation.md
@@ -1,6 +1,6 @@
 ---
 title: Propagation
-weight: 35
+weight: 60
 ---
 
 ## Cross Service Propagators

diff --git a/content/en/docs/instrumentation/erlang/resources.md b/content/en/docs/instrumentation/erlang/resources.md
@@ -1,6 +1,6 @@
 ---
 title: Resources
-weight: 36
+weight: 70
 ---
 
 A [resource](/docs/specs/otel/overview/#resources) represents an entity

diff --git a/content/en/docs/instrumentation/erlang/sampling.md b/content/en/docs/instrumentation/erlang/sampling.md
@@ -1,6 +1,6 @@
 ---
 title: Sampling
-weight: 37
+weight: 80
 ---
 
 [Sampling](/docs/concepts/sampling/) is a process that restricts the amount of

diff --git a/content/en/docs/instrumentation/erlang/testing.md b/content/en/docs/instrumentation/erlang/testing.md
@@ -1,6 +1,6 @@
 ---
 title: Testing
-weight: 40
+weight: 100
 ---
 
 When relying on OpenTelemetry for your Observability needs, it can be important

diff --git a/content/en/docs/instrumentation/java/api.md b/content/en/docs/instrumentation/java/api.md
@@ -4,5 +4,5 @@ linkTitle: API
 redirect: https://javadoc.io/doc/io.opentelemetry
 manualLinkTarget: _blank
 _build: { render: link }
-weight: 50
+weight: 210
 ---
diff --git a/content/en/docs/instrumentation/java/automatic/_index.md b/content/en/docs/instrumentation/java/automatic/_index.md
@@ -5,7 +5,7 @@ aliases:
   - /docs/java/automatic_instrumentation
   - /docs/instrumentation/java/automatic_instrumentation
 spelling: cSpell:ignore javaagent myapp Dotel
-weight: 3
+weight: 20
 ---
 
 Automatic instrumentation with Java uses a Java agent JAR that can be attached

diff --git a/content/en/docs/instrumentation/java/automatic/agent-config.md b/content/en/docs/instrumentation/java/automatic/agent-config.md
@@ -1,7 +1,7 @@
 ---
 title: Agent Configuration
 linkTitle: Configuration
-weight: 2
+weight: 10
 spelling:
   cSpell:ignore akka autoconfiguration Autoconfiguration Dotel HSET javaagent
   cSpell:ignore serverlessapis Servlet servlet

diff --git a/content/en/docs/instrumentation/java/automatic/annotations.md b/content/en/docs/instrumentation/java/automatic/annotations.md
@@ -2,7 +2,7 @@
 title: Annotations
 description: Using instrumentation annotations with a Java agent.
 aliases: [/docs/instrumentation/java/annotations]
-weight: 4
+weight: 20
 javaInstrumentationVersion: 1.26.0
 ---
 

diff --git a/content/en/docs/instrumentation/java/automatic/extensions.md b/content/en/docs/instrumentation/java/automatic/extensions.md
@@ -4,7 +4,7 @@ aliases: [/docs/instrumentation/java/extensions]
 description: >-
   Extensions add capabilities to the agent without having to create a separate
   distribution.
-weight: 10
+weight: 30
 ---
 
 ## Introduction

diff --git a/content/en/docs/instrumentation/java/examples.md b/content/en/docs/instrumentation/java/examples.md
@@ -6,5 +6,5 @@ aliases:
   - /docs/java/instrumentation_examples
   - /docs/instrumentation/java/instrumentation_examples
 _build: { render: link }
-weight: 60
+weight: 220
 ---
diff --git a/content/en/docs/instrumentation/java/getting-started.md b/content/en/docs/instrumentation/java/getting-started.md
@@ -3,7 +3,7 @@ title: Getting Started
 description: Get telemetry for your app in less than 5 minutes!
 spelling: cSpell:ignore helloworld javaagent springframework autoreconfigure
 spelling: cSpell:ignore rolldice aarch Nanos darwin autoconfigure webmvc kotlin
-weight: 1
+weight: 10
 ---
 
 This page will show you how to get started with OpenTelemetry in Java.

diff --git a/content/en/docs/instrumentation/java/manual.md b/content/en/docs/instrumentation/java/manual.md
@@ -5,7 +5,7 @@ aliases:
   - /docs/java/getting_started
   - /docs/java/manual_instrumentation
   - /docs/instrumentation/java/manual_instrumentation
-weight: 5
+weight: 30
 ---
 
 **Libraries** that want to export telemetry data using OpenTelemetry MUST only

diff --git a/content/en/docs/instrumentation/js/api.md b/content/en/docs/instrumentation/js/api.md
@@ -4,5 +4,5 @@ linkTitle: API
 redirect: https://open-telemetry.github.io/opentelemetry-js/
 manualLinkTarget: _blank
 _build: { render: link }
-weight: 50
+weight: 210
 ---