change all TIP to NOTE

anita-flegg · anita-flegg · commit 013ffde21ef2 · 2025-02-28T14:43:12.000-08:00
diff --git a/api/v4/bootstrap/index.md b/api/v4/bootstrap/index.md
@@ -51,8 +51,8 @@ HashSet<string> assemblyNamesToExclude = [SteeltoeAssemblyNames.ConfigurationCon
 builder.AddSteeltoe(assemblyNamesToExclude);
 ```
 
-> [!TIP]
-> The static class `SteeltoeAssemblyNames` enables to easily find the name of any specific assembly to exclude.
+> [!NOTE]
+> The static class `SteeltoeAssemblyNames` enables you to easily find the name of any specific assembly to exclude.
 
 ## Logging inside Configuration Providers
 
diff --git a/api/v4/configuration/config-server-provider.md b/api/v4/configuration/config-server-provider.md
@@ -35,7 +35,7 @@ The following example shows some provider settings that have been put in a JSON
 * `Spring:Application:Name` configures the "application name" to be `sample`.
 * `Spring:Cloud:Config:Uri` configures the address of the Config Server.
 
-> [!TIP]
+> [!NOTE]
 > The `Spring:Application:Name` key is also used by various other Steeltoe components.
 
 ```json
@@ -88,7 +88,7 @@ As mentioned earlier, all settings should start with `Spring:Cloud:Config:`.
 | `Health:Enabled` | Enable or disable Config Server health check contributor | `true` |
 | `Health:TimeToLive` | Health check contributor cache time to live, in milliseconds | `300_000` (5 min) |
 
-> [!TIP]
+> [!NOTE]
 > If you use self-signed certificates on Cloud Foundry, you might run into certificate validation issues when pushing an application.
 > A quick way to work around this is to disable certificate validation until a proper solution can be put in place.
 
@@ -158,7 +158,7 @@ When the `ConfigurationBuilder` builds the configuration, the Config Server clie
 
 If there are any errors or problems accessing the server, the application continues to initialize, but the values from the server are not retrieved. If this is not the behavior you want, set `Spring:Cloud:Config:FailFast` to `true`. After that is done, the application fails to start if problems occur during the retrieval.
 
-> [!TIP]
+> [!NOTE]
 > To diagnose startup errors, activate bootstrap logging as described in [Application Bootstrapping](../bootstrap/index.md#logging-inside-configuration-providers).
 
 After the configuration has been built, you can access the retrieved data directly by using `IConfiguration`. See the following example:
@@ -284,5 +284,5 @@ Aside from PEM files, Steeltoe supports a single file in PKCS#12 format:
 }
 ```
 
-> [!TIP]
+> [!NOTE]
 > A single certificate can be shared with both Config Server and Eureka by using the key `Certificates` instead of `Certificates:ConfigServer`.
diff --git a/api/v4/configuration/random-value-provider.md b/api/v4/configuration/random-value-provider.md
@@ -53,7 +53,7 @@ var builder = WebApplication.CreateBuilder(args);
 builder.Configuration.AddRandomValueSource();
 ```
 
-> [!TIP]
+> [!NOTE]
 > To generate random values as part of using placeholders, add the random value provider to the builder *before* you add the placeholder resolver.
 
 ### Access Random Value Data
diff --git a/api/v4/discovery/discovering-services.md b/api/v4/discovery/discovering-services.md
@@ -160,7 +160,7 @@ To use this load balancer in service discovery, pass it to the `AddServiceDiscov
 builder.Services.AddHttpClient<OrderService>().AddServiceDiscovery<RoundRobinLoadBalancer>();
 ```
 
-> [!TIP]
+> [!NOTE]
 > When caching is activated (see above), this load balancer stores the last-used instance index in the cache.
 > Combining it with a shared Redis cache ensures an even load distribution.
 
diff --git a/api/v4/discovery/initialize-discovery-client.md b/api/v4/discovery/initialize-discovery-client.md
@@ -37,8 +37,8 @@ builder.Services.AddConfigurationDiscoveryClient();
 var app = builder.Build();
 ```
 
-> [!TIP]
-> Alternatively, `builder.AddSteeltoe()` (Steeltoe Bootstrap Auto Configuration) can be used, which uses reflection to determine
+> [!NOTE]
+> Alternatively, you can use `builder.AddSteeltoe()` (Steeltoe Bootstrap Auto Configuration), which uses reflection to determine
 > which discovery assemblies are loaded, adding the appropriate clients automatically.
 
 ## Client configuration
diff --git a/api/v4/discovery/netflix-eureka.md b/api/v4/discovery/netflix-eureka.md
@@ -31,7 +31,7 @@ For a complete understanding of the effects of many of these settings, we recomm
 In most cases, unless you are confident that you understand the effects of changing the values from their defaults,
 we recommend that you use the defaults.
 
-> [!TIP]
+> [!NOTE]
 > Since Steeltoe v4, most of these settings can be changed at runtime, which updates the Eureka server accordingly.
 
 ### General
@@ -226,8 +226,8 @@ or:
 > [!NOTE]
 > To support certificate rotation, the configuration keys and the files on disk are automatically monitored for changes.
 
-> [!TIP]
-> A single certificate can be shared with both Config Server and Eureka, by using the key "Certificates" instead of "Certificates:Eureka".
+> [!NOTE]
+> A single certificate can be shared with both Config Server and Eureka, by using the key `Certificates` instead of `Certificates:Eureka`.
 
 ### Using custom HTTP headers
 
diff --git a/api/v4/management/cloud-foundry.md b/api/v4/management/cloud-foundry.md
@@ -47,7 +47,7 @@ builder.Configuration.AddCloudFoundry();
 builder.Services.AddCloudFoundryActuator();
 ```
 
-> [!TIP]
+> [!NOTE]
 > It is recommended that you use `AddAllActuators()` instead of adding individual actuators,
 > which enables individually turning them on/off at runtime via configuration.
 
diff --git a/api/v4/management/dbmigrations.md b/api/v4/management/dbmigrations.md
@@ -36,7 +36,7 @@ var builder = WebApplication.CreateBuilder(args);
 builder.Services.AddDbMigrationsActuator();
 ```
 
-> [!TIP]
+> [!NOTE]
 > It is recommended that you use `AddAllActuators()` instead of adding individual actuators,
 > which enables individually turning them on/off at runtime via configuration.
 
diff --git a/api/v4/management/health.md b/api/v4/management/health.md
@@ -82,7 +82,7 @@ var builder = WebApplication.CreateBuilder(args);
 builder.Services.AddHealthActuator();
 ```
 
-> [!TIP]
+> [!NOTE]
 > It is recommended that you use `AddAllActuators()` instead of adding individual actuators,
 > which enables individually turning them on/off at runtime via configuration.
 
@@ -91,7 +91,7 @@ For example, when a health check fails, the response status code is `503 Service
 The configuration key `Management:Endpoints:UseStatusCodeFromResponse` can be set to `false`, which makes the health check always respond with status code `200 OK`.
 Clients can overrule this per request by sending an `X-Use-Status-Code-From-Response` HTTP header with the value `true` or `false`.
 
-> [!TIP]
+> [!NOTE]
 > By default, health contributors for disk space and ping are activated. They can be turned off through configuration:
 >
 > ```json
diff --git a/api/v4/management/httpexchanges.md b/api/v4/management/httpexchanges.md
@@ -102,7 +102,7 @@ var builder = WebApplication.CreateBuilder(args);
 builder.Services.AddHttpExchangesActuator();
 ```
 
-> [!TIP]
+> [!NOTE]
 > It is recommended that you use `AddAllActuators()` instead of adding individual actuators,
 > which enables individually turning them on/off at runtime via configuration.
 
diff --git a/api/v4/management/hypermedia.md b/api/v4/management/hypermedia.md
@@ -57,7 +57,7 @@ var builder = WebApplication.CreateBuilder(args);
 builder.Services.AddHypermediaActuator();
 ```
 
-> [!TIP]
+> [!NOTE]
 > It is recommended that you use `AddAllActuators()` instead of adding individual actuators,
 > which enables individually turning them on/off at runtime via configuration.
 
diff --git a/api/v4/management/info.md b/api/v4/management/info.md
@@ -37,7 +37,7 @@ var builder = WebApplication.CreateBuilder(args);
 builder.Services.AddInfoActuator();
 ```
 
-> [!TIP]
+> [!NOTE]
 > It is recommended that you use `AddAllActuators()` instead of adding individual actuators,
 > which enables individually turning them on/off at runtime via configuration.
 
@@ -62,7 +62,7 @@ This contributor exposes any values below the `Info` configuration key. For exam
 }
 ```
 
-> [!TIP]
+> [!NOTE]
 > When combined with the [Placeholder Configuration Provider](../configuration/placeholder-provider.md),
 > compound configuration values can be exposed originating from other places in configuration.
 
@@ -71,7 +71,7 @@ This contributor exposes any values below the `Info` configuration key. For exam
 Exposes information from the `git.properties` Spring Boot file, if available.
 Shows information from git, such as branch/tag name, commit hash, and remote.
 
-> [!TIP]
+> [!NOTE]
 > For an example of how to use this contributor within MSBuild using [GitInfo](https://github.com/devlooped/GitInfo), see the [Steeltoe Management sample](https://github.com/SteeltoeOSS/Samples/tree/main/Management/src).
 
 ## Sample Output
diff --git a/api/v4/management/loggers.md b/api/v4/management/loggers.md
@@ -35,11 +35,11 @@ var builder = WebApplication.CreateBuilder(args);
 builder.Services.AddLoggersActuator();
 ```
 
-> [!TIP]
+> [!NOTE]
 > It is recommended that you use `AddAllActuators()` instead of adding individual actuators,
 > which enables individually turning them on/off at runtime via configuration.
 
-> [!TIP]
+> [!NOTE]
 > When `AddLoggersActuator` is called, it tries to register [Dynamic Console Logging](../logging/dynamic-console-logging.md).
 > If you'd like to use Serilog instead, call `AddDynamicSerilog` *before* `AddLoggersActuator`.
 
@@ -135,7 +135,7 @@ by sending a POST request to `/actuator/loggers/Steeltoe.Management` with the fo
 }
 ```
 
-> [!TIP]
+> [!NOTE]
 > Because the logger category is part of the request URL, avoid using colons in the name to prevent invalid HTTP requests.
 
 To verify the change was applied, send a `GET` request to `/actuator/loggers` to see the updated loggers.
@@ -203,5 +203,5 @@ The returned `ILogger` instances are wrapped as well, so that the minimum level
 When changes to `appsettings.json` are saved, existing loggers are updated with the new minimum levels, unless overridden.
 A reset of an overridden logger reverts to the updated level from `appsettings.json`.
 
-> [!TIP]
+> [!NOTE]
 > The Steeltoe dynamic logging provider can be combined with `BootstrapLoggerFactory` to upgrade loggers after startup.
diff --git a/api/v4/management/mappings.md b/api/v4/management/mappings.md
@@ -34,7 +34,7 @@ var builder = WebApplication.CreateBuilder(args);
 builder.Services.AddRouteMappingsActuator();
 ```
 
-> [!TIP]
+> [!NOTE]
 > It is recommended that you use `AddAllActuators()` instead of adding individual actuators,
 > which enables individually turning them on/off at runtime via configuration.
 
diff --git a/api/v4/management/refresh.md b/api/v4/management/refresh.md
@@ -39,7 +39,7 @@ var builder = WebApplication.CreateBuilder(args);
 builder.Services.AddRefreshActuator();
 ```
 
-> [!TIP]
+> [!NOTE]
 > It is recommended that you use `AddAllActuators()` instead of adding individual actuators,
 > which enables individually turning them on/off at runtime via configuration.
 
diff --git a/api/v4/management/services.md b/api/v4/management/services.md
@@ -36,7 +36,7 @@ var builder = WebApplication.CreateBuilder(args);
 builder.Services.AddServicesActuator();
 ```
 
-> [!TIP]
+> [!NOTE]
 > It is recommended that you use `AddAllActuators()` instead of adding individual actuators,
 > which enables individually turning them on/off at runtime via configuration.
 
diff --git a/api/v4/management/springbootadmin.md b/api/v4/management/springbootadmin.md
@@ -59,7 +59,7 @@ a few additional steps are needed:
 
   For the server to report the app as "UP", you need to add at least the hypermedia and health actuators in `Program.cs`.
 
-> [!TIP]
+> [!NOTE]
 > You can use the [Steeltoe docker image for SBA](https://github.com/SteeltoeOSS/Samples/blob/main/CommonTasks.md#spring-boot-admin) for testing purposes.
 
 Putting it all together, your `appsettings.Development.json` file should look like this:
@@ -133,5 +133,5 @@ app.MapControllers();
 app.Run();
 ```
 
-> [!TIP]
+> [!NOTE]
 > To see all the Spring Boot Admin features in action, replace the `Add*Actuator()` calls in `Program.cs` with `AddAllActuators()` and [expose all endpoints](./using-endpoints.md#exposing-endpoints).
diff --git a/api/v4/management/tasks.md b/api/v4/management/tasks.md
@@ -115,7 +115,7 @@ Invoking the command on Cloud Foundry looks similar to this:
 cf run-task YourAppName "dotnet run -- RunTask=ExampleTaskName" --name ExampleTaskName
 ```
 
-> [!TIP]
+> [!NOTE]
 > The command line configuration provider is added by default when using `WebApplication.CreateBuilder(args)`.
 > If the task does not fire when running from the command line with the `RunTask=` parameter,
 > verify that the configuration provider has been added for your application.
diff --git a/api/v4/management/threaddump.md b/api/v4/management/threaddump.md
@@ -15,7 +15,7 @@ Each key must be prefixed with `Management:Endpoints:ThreadDump:`.
 | `RequiredPermissions` | Permissions required to access the endpoint, when running on Cloud Foundry. | `Restricted` |
 | `AllowedVerbs` | An array of HTTP verbs the endpoint is exposed at. | `GET` |
 
-> [!TIP]
+> [!NOTE]
 > In version 4, the configuration key prefix for this endpoint changed from `Management:Endpoints:Dump:` to `Management:Endpoints:ThreadDump:`
 
 ## Enable HTTP Access
diff --git a/api/v4/security/certificate.md b/api/v4/security/certificate.md
@@ -78,7 +78,7 @@ builder.Services.AddAuthorizationBuilder()
     .AddOrgAndSpacePolicies();
 ```
 
-> [!TIP]
+> [!NOTE]
 > Steeltoe configures the certificate forwarding middleware to look for a certificate in the `X-Client-Cert` HTTP header.
 > To change the HTTP header name used for authorization, include it when registering the policy. For example: `.AddOrgAndSpacePolicies("X-Custom-Certificate-Header")`.
 
@@ -112,8 +112,8 @@ app.UseCertificateAuthorization();
 
 As implied by the name of the extension method `AddOrgAndSpacePolicies` from the previous section on this page, Steeltoe provides policies for validating that a request came from an application in the same org and/or the same space. You can secure endpoints by using the standard ASP.NET Core `Authorize` attribute with these security policies.
 
-> [!TIP]
-> If needed, see the Microsoft documentation on [authorization in ASP.NET Core](https://learn.microsoft.com/aspnet/core/security/authorization/introduction) for a better understanding of how to use these attributes.
+> [!NOTE]
+> If needed, see the Microsoft documentation about [authorization in ASP.NET Core](https://learn.microsoft.com/aspnet/core/security/authorization/introduction) for a better understanding of how to use these attributes.
 
 The following example shows a controller using the security attributes with the included policies:
 
@@ -163,8 +163,8 @@ In order to use app instance identity certificates in a client application, serv
 For applications that need to send identity certificates in outgoing requests, Steeltoe provides a smooth experience through an extension method on `IHttpClientBuilder` named `AddAppInstanceIdentityCertificate`.
 This method invokes code that handles loading certificates from paths defined in the application's configuration, monitors those file paths and their content for changes, and places the certificate in an HTTP header named `X-Client-Cert` on all outbound requests.
 
-> [!TIP]
-> If needed, see the Microsoft documentation on [IHttpClientFactory documentation](https://learn.microsoft.com/aspnet/core/fundamentals/http-requests) for details.
+> [!NOTE]
+> If needed, see the Microsoft documentation about [IHttpClientFactory](https://learn.microsoft.com/aspnet/core/fundamentals/http-requests) for details.
 
 ```csharp
 using Steeltoe.Security.Authorization.Certificate;
diff --git a/api/v4/security/jwt-bearer.md b/api/v4/security/jwt-bearer.md
@@ -119,7 +119,7 @@ app.MapDefaultControllerRoute();
 app.Run();
 ```
 
-> [!TIP]
+> [!NOTE]
 > In the sample code above, `app.UseForwardedHeaders` is used so that any links generated within the application will be compatible with reverse-proxy scenarios, such as when running in Cloud Foundry.
 
 ### Securing Endpoints
diff --git a/api/v4/security/redis-key-storage-provider.md b/api/v4/security/redis-key-storage-provider.md
@@ -115,5 +115,5 @@ cf restage sampleApp
 
 Once the service is bound to your application, the configuration settings are available in `VCAP_SERVICES`.
 
-> [!TIP]
-> Explore the [Steeltoe sample application](https://github.com/SteeltoeOSS/Samples/blob/main/Security/src/RedisDataProtection/README.md) for a demonstration on why this provider is useful.
+> [!NOTE]
+> Refer to the [Steeltoe sample application](https://github.com/SteeltoeOSS/Samples/blob/main/Security/src/RedisDataProtection/README.md) for a demonstration on why this provider is useful.
diff --git a/api/v4/security/sso-open-id.md b/api/v4/security/sso-open-id.md
@@ -134,7 +134,7 @@ app.MapDefaultControllerRoute();
 app.Run();
 ```
 
-> [!TIP]
+> [!NOTE]
 > In the sample code above, `app.UseForwardedHeaders` is used so that any links generated within the application will be compatible with reverse-proxy scenarios, such as when running in Cloud Foundry.
 
 ### Securing Endpoints
@@ -166,7 +166,7 @@ The preceding example establishes the following security rules:
 * If a user attempts to access the `Privacy` action and the user is not authenticated, the user is redirected to the OAuth server (such as a UAA Server) to log in.
 * If an authenticated user attempts to access the `TestGroup` action but does not meet the restrictions established by the referenced policy, the user is denied access.
 
-> [!TIP]
+> [!NOTE]
 > The Steeltoe UAA server has several pre-provisioned user accounts. Sign in with `testuser` and password `password` to access resources secured with `sampleapi.read`
 > To test with a user that does not have the permission `sampleapi.read`, sign in with the user `customer` and password `password`.
 >
diff --git a/api/v4/tracing/index.md b/api/v4/tracing/index.md
@@ -87,7 +87,7 @@ As a replacement for what Steeltoe used to provide for using these samplers, set
 * `always_on`
 * `always_off`
 
-> [!TIP]
+> [!NOTE]
 > OpenTelemetry is generally built to follow the [options pattern](https://learn.microsoft.com/dotnet/core/extensions/options).
 > There are more ways to configure options than demonstrated on this page; these are just examples to help you get started.
 
@@ -166,7 +166,7 @@ builder.Services.Configure<AspNetCoreTraceInstrumentationOptions>(options =>
 });
 ```
 
-> [!TIP]
+> [!NOTE]
 > By default, the ASP.NET Core instrumentation does not filter out any requests.
 > The alternative approach described can quickly prove unwieldy if there are many patterns to ignore, such as when listing many file types.
 
diff --git a/api/v4/welcome/common-steps.md b/api/v4/welcome/common-steps.md
@@ -17,7 +17,7 @@ You can use the `dotnet` CLI to [build and locally publish](https://learn.micros
 * Linux: `dotnet publish --framework net8.0 --runtime linux-x64`
 * macOS: `dotnet publish --framework net8.0 --runtime osx-x64`
 
-> [!TIP]
+> [!NOTE]
 > Since .NET Core 2.0, the `dotnet publish` command automatically runs the NuGet package restore for you. Running `dotnet restore` explicitly is no longer required.
 
 ## Cloud Foundry Push Sample
