Update Note/Warnings md-syntax (open-telemetry#3081)

Kielek · Nov 8, 2023 · 3669446 · 3669446
1 parent 4b1644c
commit 3669446
Show file tree

Hide file tree

Showing 6 changed files with 14 additions and 14 deletions.
diff --git a/docs/README.md b/docs/README.md
@@ -7,7 +7,7 @@ to .NET applications without having to modify their source code.
 
 ---
 
-> **Warning**
+> [!WARNING]
 > The following documentation refers to the in-development version
 of OpenTelemetry .NET Automatic Instrumentation. Docs for the latest version
 ([1.1.0](https://github.com/open-telemetry/opentelemetry-dotnet-instrumentation/releases/latest))
@@ -86,7 +86,7 @@ Supported processor architectures are:
 - x86
 - AMD64 (x86-64)
 
-> **Note**
+> [!NOTE]
 > ARM architectures are not supported yet,
 > see [#2181](https://github.com/open-telemetry/opentelemetry-dotnet-instrumentation/issues/2181).
 
@@ -118,7 +118,7 @@ or `--runtime` is used when running the command.
 Download and extract the appropriate binaries from
 [the latest release](https://github.com/open-telemetry/opentelemetry-dotnet-instrumentation/releases/latest).
 
-> **Note**
+> [!NOTE]
 > The path where you put the binaries is referenced as `$INSTALL_DIR`
 
 ### Instrument a .NET application
@@ -146,15 +146,15 @@ When running your application, make sure to:
 | `DOTNET_STARTUP_HOOKS`     | .NET                | `$INSTALL_DIR/net/OpenTelemetry.AutoInstrumentation.StartupHook.dll`      |
 | `OTEL_DOTNET_AUTO_HOME`    | All versions        | `$INSTALL_DIR`                                                            |
 
-> **Note**
+> [!NOTE]
 > Some settings can be omitted on .NET. For more information, see [config.md](config.md#net-clr-profiler).
 
 ### Shell scripts
 
 You can install OpenTelemetry .NET Automatic Instrumentation
 and instrument your .NET application using the provided Shell scripts.
 
-> **Note**
+> [!NOTE]
 > On macOS [`coreutils`](https://formulae.brew.sh/formula/coreutils) is required.
 
 Example usage:
@@ -247,7 +247,7 @@ Update-OpenTelemetryCore
 Register-OpenTelemetryForWindowsService -WindowsServiceName MyServiceName -OTelServiceName MyOtelServiceName
 ```
 
-> **Warning**
+> [!WARNING]
 > The PowerShell module works only on PowerShell 5.1
 which is the one installed by default on Windows.
 

diff --git a/docs/config.md b/docs/config.md
@@ -305,7 +305,7 @@ Important environment variables include:
 
 **Status**: [Experimental](https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/versioning-and-stability.md)
 
-> **Warning**
+> [!WARNING]
 > **Do NOT use in production.**
 >
 > Prometheus exporter is intended for the inner dev loop.

diff --git a/docs/developing.md b/docs/developing.md
@@ -196,7 +196,7 @@ You can also find the exported telemetry in `dev/log` directory.
 
 ### Instrument an application
 
-> **Warning**
+> [!WARNING]
 > Make sure to build and prepare the test environment beforehand.
 
 You can reuse [`instrument.sh`](../instrument.sh) to export profiler
@@ -250,7 +250,7 @@ To update set of the version modify [`PackageVersionDefinitions.cs`](../tools/Li
 execute [`LibraryVersionsGenerator`](../tools/LibraryVersionsGenerator/LibraryVersionsGenerator.csproj),
 and commit generated files.
 
-> **Note**
+> [!NOTE]
 > `TestApplication.AspNet.NetFramework` is an exception to this strategy
 > as it would not work well, because of multiple dependent packages.
 > `TestApplication.AspNet.NetFramework` references the latest versions

diff --git a/docs/iis-instrumentation.md b/docs/iis-instrumentation.md
@@ -24,12 +24,12 @@ the debug-level tracer logs will show that no ReJIT's (bytecode rewriting) have
 occurred. See this [issue](https://github.com/open-telemetry/opentelemetry-dotnet-instrumentation/issues/2934#issuecomment-1746669737)
 for further details.
 
-> **Warning**
+> [!WARNING]
 > `Register-OpenTelemetryForIIS` performs IIS restart.
 
 ## Configuration
 
-> **Note**
+> [!NOTE]
 > Remember to restart IIS after making configuration changes.
 > You can do it by executing `iisreset.exe`.
 

diff --git a/docs/log-trace-correlation.md b/docs/log-trace-correlation.md
@@ -1,6 +1,6 @@
 # Log to trace correlation
 
-> **Note**
+> [!NOTE]
 > Automatic log to trace correlation provided by OpenTelemetry .NET Automatic Instrumentation
 > currently works only for .NET applications using `Microsoft.Extensions.Logging`.
 > See [#2310](https://github.com/open-telemetry/opentelemetry-dotnet-instrumentation/issues/2310)

diff --git a/docs/windows-service-instrumentation.md b/docs/windows-service-instrumentation.md
@@ -16,12 +16,12 @@ Install-OpenTelemetryCore
 Register-OpenTelemetryForWindowsService -WindowsServiceName "WindowsServiceName" -OTelServiceName "MyServiceDisplayName"
 ```
 
-> **Warning**
+> [!WARNING]
 > `Register-OpenTelemetryForWindowsService` performs a service restart.
 
 ## Configuration
 
-> **Note**
+> [!NOTE]
 > Remember to restart the Windows Service after making configuration changes.
 > You can do it by executing
 > `Restart-Service -Name $WindowsServiceName -Force` in PowerShell.