Skip to content

Commit

Permalink
fix up missing periods
Browse files Browse the repository at this point in the history
  • Loading branch information
gewarren committed Jan 24, 2025
1 parent 47d9e00 commit fa22145
Show file tree
Hide file tree
Showing 61 changed files with 167 additions and 171 deletions.
6 changes: 3 additions & 3 deletions docs/azure/key-azure-services.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,8 +22,8 @@ While Azure contains over 100 services, the following Azure services are the ser
| ![Azure Service Bus Icon](./media/service-bus.svg) | **Azure Service Bus** | Azure Service Bus is a fully managed enterprise message broker supporting both point to point and publish-subscribe integrations. It is ideal for building decoupled applications, queue based load leveling, or facilitating communication between microservices. |
| ![Azure Key Vault Icon](./media/azure-key-vault.svg) | **Azure Key Vault** | Every application has application secrets like connection strings and API keys it must store. Azure Key Vault helps you store and access those secrets securely, in an encrypted vault with restricted access to make sure your secrets and your application are not compromised. |

For the full list of Azure products and services, visit the [Azure documentation home page](/azure/?product=all)
For the full list of Azure products and services, visit the [Azure documentation home page](/azure/?product=all).

### Next steps
## Next steps

Start configuring your Azure development environment by [Creating an Azure Account](create-azure-account.md)
Start configuring your Azure development environment by [Creating an Azure Account](create-azure-account.md).
2 changes: 1 addition & 1 deletion docs/azure/migration/vm.md
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ Azure Virtual Networks enable you to:
- Connect your VM to your on-premises network using one of several [connectivity options](/azure/vpn-gateway/vpn-gateway-about-vpngateways#s2smulti)
- Integrate your virtual machine into your on-premises network using [ExpressRoute](https://azure.microsoft.com/services/expressroute/)

To get started, see the [Virtual Network documentation](/azure/virtual-network/)
To get started, see the [Virtual Network documentation](/azure/virtual-network/).

### Active Directory

Expand Down
4 changes: 2 additions & 2 deletions docs/azure/sdk/resource-management.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,13 +18,13 @@ Those packages follow the [new Azure SDK guidelines](https://azure.github.io/azu
- Distributed tracing.

> [!NOTE]
> You may notice that some packages are still pre-release version, phased releases of additional Azure services' management plane libraries are in process. If you are looking for a stable version package for a particular azure resource and currently only a pre-release version is available, please raise an issue in [Azure SDK for .NET Github repo](https://github.com/Azure/azure-sdk-for-net/issues/new?assignees=&labels=&template=02_feature_request.yml&title=%5BFEATURE+REQ%5D)
> You might notice that some packages are still prerelease version. Phased releases of additional Azure services' management plane libraries are in process. If you're looking for a stable version package for a particular Azure resource and currently only a prerelease version is available, please raise an issue in [Azure SDK for .NET GitHub repo](https://github.com/Azure/azure-sdk-for-net/issues/new?assignees=&labels=&template=02_feature_request.yml&title=%5BFEATURE+REQ%5D).
## Get started

### Prerequisites

- An [Azure subscription](https://azure.microsoft.com/free/dotnet/)
- An [Azure subscription](https://azure.microsoft.com/free/dotnet/).
- A [TokenCredential](/dotnet/api/azure.core.tokencredential?view=azure-dotnet&preserve-view=false) implementation, such as an [Azure Identity library credential type](/dotnet/api/overview/azure/Identity-readme#credential-classes).

### Install the package
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ Use the recommended replacement APIs.
* Removed the constructor [Microsoft.AspNetCore.Mvc.Infrastructure.ObjectResultExecutor](/dotnet/api/microsoft.aspnetcore.mvc.infrastructure.objectresultexecutor.-ctor?view=aspnetcore-3.1&preserve-view=true#Microsoft_AspNetCore_Mvc_Infrastructure_ObjectResultExecutor__ctor_Microsoft_AspNetCore_Mvc_Infrastructure_OutputFormatterSelector_Microsoft_AspNetCore_Mvc_Infrastructure_IHttpResponseStreamWriterFactory_Microsoft_Extensions_Logging_ILoggerFactory_). Use <xref:Microsoft.AspNetCore.Mvc.Infrastructure.ObjectResultExecutor.%23ctor(Microsoft.AspNetCore.Mvc.Infrastructure.OutputFormatterSelector,Microsoft.AspNetCore.Mvc.Infrastructure.IHttpResponseStreamWriterFactory,Microsoft.Extensions.Logging.ILoggerFactory,Microsoft.Extensions.Options.IOptions{Microsoft.AspNetCore.Mvc.MvcOptions})?displayProperty=nameWithType> instead.
* Removed [Microsoft.AspNetCore.Mvc.ModelBinding.Validation.ValidationVisitor.AllowShortCircuitingValidationWhenNoValidatorsArePresent](/dotnet/api/microsoft.aspnetcore.mvc.modelbinding.validation.validationvisitor.allowshortcircuitingvalidationwhennovalidatorsarepresent?view=aspnetcore-3.1&preserve-view=true#Microsoft_AspNetCore_Mvc_ModelBinding_Validation_ValidationVisitor_AllowShortCircuitingValidationWhenNoValidatorsArePresent).
* Removed [Microsoft.AspNetCore.Mvc.ViewFeatures.ViewComponentResultExecutor](/dotnet/api/microsoft.aspnetcore.mvc.viewfeatures.viewcomponentresultexecutor.-ctor?view=aspnetcore-3.1&preserve-view=true#Microsoft_AspNetCore_Mvc_ViewFeatures_ViewComponentResultExecutor__ctor_Microsoft_Extensions_Options_IOptions_Microsoft_AspNetCore_Mvc_MvcViewOptions__Microsoft_Extensions_Logging_ILoggerFactory_System_Text_Encodings_Web_HtmlEncoder_Microsoft_AspNetCore_Mvc_ModelBinding_IModelMetadataProvider_Microsoft_AspNetCore_Mvc_ViewFeatures_ITempDataDictionaryFactory_). Use <xref:Microsoft.AspNetCore.Mvc.ViewFeatures.ViewComponentResultExecutor.%23ctor(Microsoft.Extensions.Options.IOptions{Microsoft.AspNetCore.Mvc.MvcViewOptions},Microsoft.Extensions.Logging.ILoggerFactory,System.Text.Encodings.Web.HtmlEncoder,Microsoft.AspNetCore.Mvc.ModelBinding.IModelMetadataProvider,Microsoft.AspNetCore.Mvc.ViewFeatures.ITempDataDictionaryFactory,Microsoft.AspNetCore.Mvc.Infrastructure.IHttpResponseStreamWriterFactory)?displayProperty=nameWithType> instead.
* Obsoleted [CompatibilityVersion](/dotnet/api/microsoft.aspnetcore.mvc.compatibilityversion?view=aspnetcore-3.1&preserve-view=true)
* Obsoleted [CompatibilityVersion](/dotnet/api/microsoft.aspnetcore.mvc.compatibilityversion?view=aspnetcore-3.1&preserve-view=true).

<!--
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -137,7 +137,7 @@ In this case, the trim analysis keeps public methods of <xref:System.Tuple>, and
* When code is incompatible with trimming, annotate it with `RequiresUnreferencedCode` and propagate this annotation to callers until the relevant public APIs are annotated.
* Avoid using code that uses reflection in a way not understood by the static analysis. For example, reflection in static constructors should be avoided. Using statically unanalyzable reflection in static constructors result in the warning propagating to all members of the class.
* Avoid annotating virtual methods or interface methods. Annotating virtual or interface methods requires all overrides to have matching annotations.
* If an API is mostly trim-incompatible, alternative coding approaches to the API might need to be considered. A common example is reflection-based serializers. In these cases, consider adopting other technology like source generators to produce code that is more easily statically analyzed. For example, see [How to use source generation in System.Text.Json](../../../standard/serialization/system-text-json/source-generation.md)
* If an API is mostly trim-incompatible, alternative coding approaches to the API might need to be considered. A common example is reflection-based serializers. In these cases, consider adopting other technology like source generators to produce code that is more easily statically analyzed. For example, see [How to use source generation in System.Text.Json](../../../standard/serialization/system-text-json/source-generation.md).

## Resolve warnings for non-analyzable patterns

Expand Down
4 changes: 1 addition & 3 deletions docs/core/deploying/trimming/trim-warnings/il2016.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,9 +14,7 @@ Could not find event on type.

## Rule description

An event specified in an [XML file for the trimmer](https://github.com/dotnet/runtime/blob/main/docs/tools/illink/data-formats.md)
file could not be found in the type matching the `fullname` argument that was passed to
the parent of the `event` element.
An event specified in an [XML file for the trimmer](https://github.com/dotnet/runtime/blob/main/docs/tools/illink/data-formats.md) file could not be found in the type matching the `fullname` argument that was passed to the parent of the `event` element.

## Example

Expand Down
4 changes: 1 addition & 3 deletions docs/core/deploying/trimming/trim-warnings/il2017.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,9 +14,7 @@ Could not find property on type.

## Rule description

A property specified in an [XML file for the trimmer](https://github.com/dotnet/runtime/blob/main/docs/tools/illink/data-formats.md)
file could not be found in the type matching the `fullname` argument that was passed to
the parent of the `property` element.
A property specified in an [XML file for the trimmer](https://github.com/dotnet/runtime/blob/main/docs/tools/illink/data-formats.md) file could not be found in the type matching the `fullname` argument that was passed to the parent of the `property` element.

## Example

Expand Down
2 changes: 1 addition & 1 deletion docs/core/diagnostics/built-in-metrics.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,5 +18,5 @@ This is a reference for [metrics](metrics.md) built-in for .NET, produced using

## Older metric APIs

For built-in metrics produced by [alternative metric APIs](compare-metric-apis.md)
For built-in metrics produced by [alternative metric APIs](compare-metric-apis.md),
see the [EventCounters reference](available-counters.md) and [Windows Performance Counter reference](../../framework/debug-trace-profile/performance-counters.md).
3 changes: 1 addition & 2 deletions docs/core/diagnostics/compare-metric-apis.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,8 +30,7 @@ Although this API was designed to work well with OpenTelemetry and its growing e
### PerformanceCounter

<xref:System.Diagnostics.PerformanceCounter?displayProperty=nameWithType> APIs are the oldest .NET metric APIs. They're only supported on Windows and provide
a managed wrapper for Windows OS [Performance Counter](/windows/win32/perfctrs/performance-counters-portal)
technology. They are available in all supported versions of .NET.
a managed wrapper for Windows OS [Performance Counter](/windows/win32/perfctrs/performance-counters-portal) technology. They are available in all supported versions of .NET.

These APIs are provided primarily for compatibility; the .NET team
considers this a stable area that's unlikely to receive further improvement aside from bug fixes. These APIs are not suggested
Expand Down
8 changes: 4 additions & 4 deletions docs/core/diagnostics/debug-stackoverflow.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ Often just seeing this callstack on the console above is enough to identify the

This example creates a core dump when the StackOverflowException occurs, then loads the dump into [lldb](https://lldb.llvm.org/) (a common Linux command-line debugger) and debugs it.

1. Run the app with it configured to collect a dump on crash
1. Run the app with it configured to collect a dump on crash.

````
> export DOTNET_DbgEnableMiniDump=1
Expand All @@ -61,7 +61,7 @@ This example creates a core dump when the StackOverflowException occurs, then lo
[!INCLUDE [complus-prefix](../../../includes/complus-prefix.md)]
2. Install the SOS extension using [dotnet-sos](dotnet-sos.md)
2. Install the SOS extension using [dotnet-sos](dotnet-sos.md).
````
dotnet-sos install
Expand All @@ -85,7 +85,7 @@ This example creates a core dump when the StackOverflowException occurs, then lo
...
````
4. The top frame `0x00007f59b40900cc` is repeated several times. Use the [SOS](sos-debugging-extension.md) `ip2md` command to figure out what managed method is located at the `0x00007f59b40900cc` address
4. The top frame `0x00007f59b40900cc` is repeated several times. Use the [SOS](sos-debugging-extension.md) `ip2md` command to figure out what managed method is located at the `0x00007f59b40900cc` address.
````
(lldb) ip2md 0x00007f59b40900cc
Expand Down Expand Up @@ -120,7 +120,7 @@ The callstack debugger window also shows the stack.
You can use all the normal Visual Studio debugger features to investigate each frame on the callstack, its source code, and the value of local variables.
## See Also
## See also
* [An introduction to dumps in .NET](dumps.md)
* [Debug Linux dumps](debug-linux-dumps.md)
Expand Down
8 changes: 4 additions & 4 deletions docs/core/diagnostics/event-counters.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ ms.date: 08/27/2024
EventCounters are .NET APIs used for lightweight, cross-platform, and near real-time performance metric collection. EventCounters were added as a cross-platform alternative to the "performance counters" of .NET Framework on Windows. In this article, you'll learn what EventCounters are, how to implement them, and how to consume them.

The .NET runtime and a few .NET libraries publish basic diagnostics information using EventCounters starting in .NET Core 3.0. Apart from the EventCounters that are provided by the .NET runtime, you may choose to implement your own EventCounters. EventCounters can be used to track various metrics. Learn more about them in [well-known EventCounters in .NET](available-counters.md)
The .NET runtime and a few .NET libraries publish basic diagnostics information using EventCounters starting in .NET Core 3.0. Apart from the EventCounters that are provided by the .NET runtime, you may choose to implement your own EventCounters. EventCounters can be used to track various metrics. Learn more about them in [well-known EventCounters in .NET](available-counters.md).

EventCounters live as a part of an <xref:System.Diagnostics.Tracing.EventSource>, and are automatically pushed to listener tools on a regular basis. Like all other events on an <xref:System.Diagnostics.Tracing.EventSource>, they can be consumed both in-proc and out-of-proc via <xref:System.Diagnostics.Tracing.EventListener> and [EventPipe](./eventpipe.md). This article focuses on the cross-platform capabilities of EventCounters, and intentionally excludes PerfView and ETW (Event Tracing for Windows) - although both can be used with EventCounters.

Expand Down Expand Up @@ -157,15 +157,15 @@ _requestRateCounter = new IncrementingPollingCounter("request-rate", this, () =>
There are two primary ways of consuming EventCounters: in-proc and out-of-proc. The consumption of EventCounters can be distinguished into three layers of various consuming technologies.

- Transporting events in a raw stream via ETW or EventPipe:

ETW APIs come with the Windows OS, and EventPipe is accessible as a [.NET API](https://github.com/dotnet/diagnostics/blob/main/documentation/design-docs/diagnostics-client-library.md#1-attaching-to-a-process-and-dumping-out-all-the-runtime-gc-events-in-real-time-to-the-console), or the diagnostic [IPC protocol](https://github.com/dotnet/diagnostics/blob/main/documentation/design-docs/ipc-protocol.md).

- Decoding the binary event stream into events:

The [TraceEvent library](https://www.nuget.org/packages/Microsoft.Diagnostics.Tracing.TraceEvent) handles both ETW and EventPipe stream formats.

- Command-line and GUI tools:

Tools like PerfView (ETW or EventPipe), dotnet-counters (EventPipe only), and dotnet-monitor (EventPipe only).

### Consume out-of-proc
Expand Down
2 changes: 1 addition & 1 deletion docs/core/diagnostics/eventsource-getting-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -83,7 +83,7 @@ This demo shows an [EventPipe](./eventpipe.md) example for .NET Core apps. To le
technology built into the .NET Core runtime to give .NET developers trace collection tools and a portable compact trace
format (*.nettrace files). [dotnet-trace](./dotnet-trace.md) is a command-line tool that collects EventPipe traces.

1. Download and Install [dotnet-trace](./dotnet-trace.md#install)
1. Download and Install [dotnet-trace](./dotnet-trace.md#install).
1. Build the console app above. This demo assumes the app is named EventSourceDemo.exe and it is in the current directory. At the command-line run:

```dotnetcli
Expand Down
5 changes: 2 additions & 3 deletions docs/core/diagnostics/eventsource-instrumentation.md
Original file line number Diff line number Diff line change
Expand Up @@ -184,14 +184,13 @@ authoring errors.
4. When debugging, that same error string will also be logged using Debug.WriteLine() and show up in the debug
output window.
5. EventSource internally throws and then catches exceptions when errors occur. To observe when these exceptions are occurring, enable first chance exceptions
in a debugger, or use event tracing with the .NET runtime's [Exception events](../../fundamentals/diagnostics/runtime-exception-events.md)
enabled.
in a debugger, or use event tracing with the .NET runtime's [Exception events](../../fundamentals/diagnostics/runtime-exception-events.md) enabled.

## Advanced customizations

### Setting OpCodes and Tasks

ETW has concepts of [Tasks and OpCodes](/windows/win32/wes/defining-tasks-and-opcodes)
ETW has concepts of [Tasks and OpCodes](/windows/win32/wes/defining-tasks-and-opcodes),
which are further mechanisms for tagging and filtering events. You can associate events with specific tasks and opcodes
using the <xref:System.Diagnostics.Tracing.EventAttribute.Task%2A> and
<xref:System.Diagnostics.Tracing.EventAttribute.Opcode%2A> properties. Here's an example:
Expand Down
4 changes: 2 additions & 2 deletions docs/core/docker/container-images.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ The following images are focused on resulting in the smallest possible image siz
- Mariner distroless
- Ubuntu chiseled

These images are smaller, as they don't include globalization dependencies such as, ICU, or tzdata. These images only work with apps that are configured for globalization invariant mode. To configure an app for invariant globalization, add the following property to the project file:
These images are smaller, as they don't include globalization dependencies such as ICU or tzdata. These images only work with apps that are configured for globalization invariant mode. To configure an app for invariant globalization, add the following property to the project file:

```xml
<PropertyGroup>
Expand Down Expand Up @@ -83,7 +83,7 @@ AOT images are published for:
- Mariner
- Ubuntu

For more information, see [Native AOT deployment](../deploying/native-aot/index.md)
For more information, see [Native AOT deployment](../deploying/native-aot/index.md).

## Docker hub repositories

Expand Down
2 changes: 1 addition & 1 deletion docs/core/extensions/custom-logging-provider.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ ms.topic: how-to
There are many [logging providers](logging-providers.md) available for common logging needs. You may need to implement a custom <xref:Microsoft.Extensions.Logging.ILoggerProvider> when one of the available providers doesn't suit your application needs. In this article, you'll learn how to implement a custom logging provider that can be used to colorize logs in the console.

> [!TIP]
> The custom logging provider example source code is available in the **Docs Github repo**. For more information, see [GitHub: .NET Docs - Console Custom Logging](https://github.com/dotnet/docs/tree/main/docs/core/extensions/snippets/configuration/console-custom-logging).
> The custom logging provider example source code is available in the **Docs GitHub repo**. For more information, see [GitHub: .NET Docs - Console Custom Logging](https://github.com/dotnet/docs/tree/main/docs/core/extensions/snippets/configuration/console-custom-logging).
### Sample custom logger configuration

Expand Down
4 changes: 2 additions & 2 deletions docs/core/extensions/logging.md
Original file line number Diff line number Diff line change
Expand Up @@ -93,7 +93,7 @@ The preceding example:

## Configure logging

Logging configuration is set in code or via external sources, such as, config files and environment variables. Using external configuration is beneficial when possible because it can be changed without rebuilding the application. However, some tasks, such as setting logging providers, can only be configured from code.
Logging configuration is set in code or via external sources, such as config files and environment variables. Using external configuration is beneficial when possible because it can be changed without rebuilding the application. However, some tasks, such as setting logging providers, can only be configured from code.

### Configure logging without code

Expand Down Expand Up @@ -141,7 +141,7 @@ Any logs below the minimum level are ***not***:

To suppress all logs, specify [LogLevel.None](xref:Microsoft.Extensions.Logging.LogLevel). `LogLevel.None` has a value of 6, which is higher than `LogLevel.Critical` (5).

If a provider supports [log scopes](#log-scopes), `IncludeScopes` indicates whether they're enabled. For more information, see [log scopes](#log-scopes)
If a provider supports [log scopes](#log-scopes), `IncludeScopes` indicates whether they're enabled. For more information, see [log scopes](#log-scopes).

The following *appsettings.json* file contains settings for all of the built-in providers:

Expand Down
Loading

0 comments on commit fa22145

Please sign in to comment.