From a878ca3eead7d1b84c3e4c379c81b665b553c41b Mon Sep 17 00:00:00 2001 From: Cijo Thomas Date: Wed, 15 Feb 2023 01:58:30 +0530 Subject: [PATCH] Few doc fixes (#4186) --- .vscode/settings.json | 1 + README.md | 6 ++++++ VERSIONING.md | 9 +++++---- 3 files changed, 12 insertions(+), 4 deletions(-) diff --git a/.vscode/settings.json b/.vscode/settings.json index b94b3d367..f82a1be7f 100644 --- a/.vscode/settings.json +++ b/.vscode/settings.json @@ -9,6 +9,7 @@ "codecov", "contoso", "cref", + "Gantt", "grafana", "ilogger", "inheritdoc", diff --git a/README.md b/README.md index d27c3e0a3..7de2546b1 100644 --- a/README.md +++ b/README.md @@ -80,6 +80,12 @@ See the [OpenTelemetry registry](https://opentelemetry.io/registry/?s=net) and repo](https://github.com/open-telemetry/opentelemetry-dotnet-contrib) for more components. +## Troubleshooting + +See [Troubleshooting](./src/OpenTelemetry/README.md#troubleshooting). +Additionally check readme file for the individual components for any additional +troubleshooting information. + ## Extensibility OpenTelemetry .NET is designed to be extensible. Here are the most common diff --git a/VERSIONING.md b/VERSIONING.md index d1c331e7b..507d877b4 100644 --- a/VERSIONING.md +++ b/VERSIONING.md @@ -35,6 +35,10 @@ Zipkin exporter has a bug fix and is released as 1.0.1, then all other core components are also released as 1.0.1, even if there is no code change in other components. +Starting with 1.4.0, +[OpenTelemetry.Extensions.Hosting](./src/OpenTelemetry.Extensions.Hosting/README.md) +will also be versioned and released together as a core component. + ## Pre-releases Pre-release packages are denoted by appending identifiers such as -Alpha, -Beta, @@ -75,10 +79,7 @@ of separate packages. OpenTelemetry .NET relies on .NET runtime to provide several instrumentation APIs. Currently, `System.Diagnostics.DiagnosticSource` and `Microsoft.Extensions.Logging.Abstractions` are the packages from .NET runtime -this repository is dependent on. In the future, APIs for Metrics, Propagators -etc. will also come from .NET runtime itself. Depending on whether .NET runtime -choses to use same package or separate package for these, users may be required -to install separate packages for instrumenting. +this repository is dependent on. ### Packaging non-stable signals