Skip to content

Commit

Permalink
Few doc fixes (#4186)
Browse files Browse the repository at this point in the history
  • Loading branch information
cijothomas committed Feb 14, 2023
1 parent 69d015e commit a878ca3
Show file tree
Hide file tree
Showing 3 changed files with 12 additions and 4 deletions.
1 change: 1 addition & 0 deletions .vscode/settings.json
Expand Up @@ -9,6 +9,7 @@
"codecov",
"contoso",
"cref",
"Gantt",
"grafana",
"ilogger",
"inheritdoc",
Expand Down
6 changes: 6 additions & 0 deletions README.md
Expand Up @@ -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
Expand Down
9 changes: 5 additions & 4 deletions VERSIONING.md
Expand Up @@ -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,
Expand Down Expand Up @@ -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

Expand Down

0 comments on commit a878ca3

Please sign in to comment.