Skip to content

Commit 76819fa

Browse files
authored
Fix broken links (#385)
* Fix broken links * Replace links with their auto-redirect target
1 parent 0629544 commit 76819fa

File tree

11 files changed

+15
-15
lines changed

11 files changed

+15
-15
lines changed

docs/docs/v2/configuration/cloud-foundry-provider.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -112,7 +112,7 @@ var uri = config["vcap:services:service-name:0:credentials:uri"]
112112

113113
A list of all `VCAP_SERVICES` keys is available in the [VCAP_SERVICES](https://docs.CloudFoundry.org/devguide/deploy-apps/environment-variable.html#VCAP-SERVICES) topic of the Cloud Foundry documentation.
114114
115-
>NOTE: This provider uses the built-in .NET [JSON Configuration Parser](https://github.com/aspnet/Configuration/tree/dev/src/Microsoft.Extensions.Configuration.Json) when parsing the JSON provided in the `VCAP_*` environment variables. As a result, you can expect the exact same key names and behavior as you see when parsing JSON configuration files (such as `appsettings.json`) in your application.
115+
>NOTE: This provider uses the built-in .NET [JSON Configuration Parser](https://github.com/dotnet/dotnet/tree/main/src/runtime/src/libraries/Microsoft.Extensions.Configuration.Json) when parsing the JSON provided in the `VCAP_*` environment variables. As a result, you can expect the exact same key names and behavior as you see when parsing JSON configuration files (such as `appsettings.json`) in your application.
116116
117117
### Access Configuration Data as Options
118118

docs/docs/v2/connectors/mysql.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@ The following MySQL connector configuration shows how to connect to a database a
5151
}
5252
```
5353

54-
The following table describes the available settings for the connector. These settings are not specific to Steeltoe. They are passed through to the underlying data provider. See the [Oracle MySQL Connection String docs](https://dev.mysql.com/doc/connector-net/en/connector-net-connection-options.html) or [open source MySQL Connection String docs](https://mysql-net.github.io/MySqlConnector/connection-options/).
54+
The following table describes the available settings for the connector. These settings are not specific to Steeltoe. They are passed through to the underlying data provider. See the [Oracle MySQL Connection String docs](https://dev.mysql.com/doc/connector-net/en/connector-net-connections-string.html) or [open source MySQL Connection String docs](https://mysqlconnector.net/connection-options/).
5555

5656
| Key | Description | Steeltoe Default |
5757
| --- | --- | :---: |

docs/docs/v3/configuration/cloud-foundry-provider.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -103,7 +103,7 @@ var uri = config["vcap:services:service-name:0:credentials:uri"];
103103

104104
A list of all `VCAP_SERVICES` keys is available in the [VCAP_SERVICES](https://docs.CloudFoundry.org/devguide/deploy-apps/environment-variable.html#VCAP-SERVICES) topic of the Cloud Foundry documentation.
105105

106-
>This provider uses the built-in .NET [JSON Configuration Parser](https://github.com/aspnet/Configuration/tree/dev/src/Microsoft.Extensions.Configuration.Json) when parsing the JSON provided in the `VCAP_*` environment variables. As a result, you can expect the exact same key names and behavior as you see when parsing JSON configuration files (such as `appsettings.json`) in your application.
106+
>This provider uses the built-in .NET [JSON Configuration Parser](https://github.com/dotnet/dotnet/tree/main/src/runtime/src/libraries/Microsoft.Extensions.Configuration.Json) when parsing the JSON provided in the `VCAP_*` environment variables. As a result, you can expect the exact same key names and behavior as you see when parsing JSON configuration files (such as `appsettings.json`) in your application.
107107
108108
### Access Configuration Data as Options
109109

docs/docs/v3/connectors/mysql.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,7 @@ The following MySQL connector configuration shows how to connect to a database a
5050
}
5151
```
5252

53-
The following table describes the available settings for the connector. These settings are not specific to Steeltoe. They are passed through to the underlying data provider. See the [Oracle MySQL Connection String docs](https://dev.mysql.com/doc/connector-net/en/connector-net-connection-options.html) or [open source MySQL Connection String docs](https://mysql-net.github.io/MySqlConnector/connection-options/).
53+
The following table describes the available settings for the connector. These settings are not specific to Steeltoe. They are passed through to the underlying data provider. See the [Oracle MySQL Connection String docs](https://dev.mysql.com/doc/connector-net/en/connector-net-connections-string.html) or [open source MySQL Connection String docs](https://mysqlconnector.net/connection-options/).
5454

5555
| Key | Description | Steeltoe Default |
5656
| --- | --- | :---: |

docs/docs/v3/discovery/initialize-discovery-client.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,7 @@ public class Program
5757

5858
The `AddDiscoveryClient` extension shown above uses reflection to find assemblies containing a discovery client. Specifically, assemblies are located by the presence of the attribute `DiscoveryClientAssembly`, which contains a reference to an `IDiscoveryClientExtension` that does the work in configuring options and injecting the required service for the `IDiscoveryClient` to operate.
5959

60-
>If no discovery client package is found a [NoOpDiscoveryClient](https://github.com/SteeltoeOSS/Steeltoe/blob/release/3.2/src/Discovery/src/ClientBase/SimpleClients/NoOpDiscoveryClient.cs) will be used. This will happen when no client has been added or if you publish your application with [`/p:PublishSingleFile=true`](https://docs.microsoft.com/dotnet/core/deploying/single-file))
60+
>If no discovery client package is found a [NoOpDiscoveryClient](https://github.com/SteeltoeOSS/Steeltoe/blob/3.x/src/Discovery/src/ClientBase/SimpleClients/NoOpDiscoveryClient.cs) will be used. This will happen when no client has been added or if you publish your application with [`/p:PublishSingleFile=true`](https://docs.microsoft.com/dotnet/core/deploying/single-file))
6161
6262
To avoid this reflection-based approach, use declarative configuration of the client(s) you plan to use, like this:
6363

@@ -77,7 +77,7 @@ public class Program
7777

7878
As of version 3.0.2, you may add multiple `Usexxx()` statements to this options builder, so long as only one is configured at runtime.
7979

80-
>If no extension is supplied for `AddServiceDiscovery`, a [NoOpDiscoveryClient](https://github.com/SteeltoeOSS/Steeltoe/blob/3.2/src/Discovery/src/ClientBase/SimpleClients/NoOpDiscoveryClient.cs) will be used.
80+
>If no extension is supplied for `AddServiceDiscovery`, a [NoOpDiscoveryClient](https://github.com/SteeltoeOSS/Steeltoe/blob/3.x/src/Discovery/src/ClientBase/SimpleClients/NoOpDiscoveryClient.cs) will be used.
8181
8282
## Other Extensions
8383

docs/docs/v3/discovery/kubernetes.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,4 +33,4 @@ Using native Kubernetes service discovery ensures compatibility with additional
3333

3434
The calling service then need only refer to names resolvable in a particular Kubernetes cluster. This may be as simple as using the service name as the host name, or it may require a fully qualified domain name (FQDN), such as `{service-name}.{namespace}.svc.{cluster}.local:{service-port}` depending on your environment.
3535

36-
In order to use both the discovery client programming model and the platform's native capabilities, a [NoOpDiscoveryClient](https://github.com/SteeltoeOSS/Steeltoe/blob/release/3.2/src/Discovery/src/ClientBase/SimpleClients/NoOpDiscoveryClient.cs) can be used by either disabling other discovery clients, or not including them in the first place.
36+
In order to use both the discovery client programming model and the platform's native capabilities, a [NoOpDiscoveryClient](https://github.com/SteeltoeOSS/Steeltoe/blob/3.x/src/Discovery/src/ClientBase/SimpleClients/NoOpDiscoveryClient.cs) can be used by either disabling other discovery clients, or not including them in the first place.

docs/docs/v3/management/health.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -281,4 +281,4 @@ public void Configure(IApplicationBuilder app, IHostingEnvironment env, ILoggerF
281281
}
282282
```
283283

284-
A complete example is available [here](https://github.com/SteeltoeOSS/Samples/tree/3.x/Management/src/AspDotNetCore/MicrosoftHealthChecks).
284+
A complete example is available [here](https://github.com/SteeltoeOSS/Samples/tree/3.x/Management/src/MicrosoftHealthChecks).

docs/docs/v3/management/using-endpoints.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -78,7 +78,7 @@ The following table describes the settings that you can apply globally:
7878
7979
### Custom Serialization Options
8080

81-
As of 3.1.1, the `JsonSerializerOptions` used to serialize actuator responses are configurable, and custom JsonConverters can be used by adding the [assembly-qualified type](https://docs.microsoft.com/dotnet/api/system.type.assemblyqualifiedname").
81+
As of 3.1.1, the `JsonSerializerOptions` used to serialize actuator responses are configurable, and custom JsonConverters can be used by adding the [assembly-qualified type](https://docs.microsoft.com/dotnet/api/system.type.assemblyqualifiedname).
8282

8383
For example, to have DateTime values serialized as epoch times and all JSON pretty printed:
8484

docs/docs/v3/stream/standalone-stream-rabbitmq.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -125,7 +125,7 @@ namespace UsageSender
125125
```
126126

127127
The `[EnableBinding]` attribute indicates that you want to bind your application to messaging middleware.
128-
The attribute takes one or more interfaces as a parameter, in this case, the [ISource](https://github.com/SteeltoeOSS/Steeltoe/blob/main/src/Stream/src/Abstractions/Messaging/ISource.cs) interface that defines an output channel named `output`.
128+
The attribute takes one or more interfaces as a parameter, in this case, the [ISource](https://github.com/SteeltoeOSS/Steeltoe/blob/3.x/src/Stream/src/Abstractions/Messaging/ISource.cs) interface that defines an output channel named `output`.
129129
In the case of RabbitMQ, messages sent to the `output` channel are in turn sent to the RabbitMQ message broker by using a `TopicExchange`.
130130

131131
Deriving from [BackgroundService](https://docs.microsoft.com/aspnet/core/fundamentals/host/hosted-services#backgroundservice-base-class) and calling `Task.Delay` makes the UsageGenerator a background task that gets called by the framework every `5` seconds.
@@ -251,7 +251,7 @@ namespace UsageProcessor
251251
}
252252
```
253253

254-
In the preceding application, the `[EnableBinding]` attribute indicates that you want to bind your application to the messaging middleware. The attribute takes one or more interfaces as a parameter, in this case, the [IProcessor](https://github.com/SteeltoeOSS/Steeltoe/blob/main/src/Stream/src/Abstractions/Messaging/IProcessor.cs) that defines and input and output channel.
254+
In the preceding application, the `[EnableBinding]` attribute indicates that you want to bind your application to the messaging middleware. The attribute takes one or more interfaces as a parameter, in this case, the [IProcessor](https://github.com/SteeltoeOSS/Steeltoe/blob/3.x/src/Stream/src/Abstractions/Messaging/IProcessor.cs) that defines and input and output channel.
255255

256256
The `[StreamListener]` attribute binds the application's `input` channel to the `Handle` method and automatically deserializes the incoming JSON into `UsageDetail` object.
257257

@@ -337,7 +337,7 @@ namespace UsageLogger
337337
}
338338
```
339339

340-
In the preceding application, the `[EnableBinding]` attribute indicates that you want to bind your application to the messaging middleware. The attribute takes one or more interfaces as a parameter, in this case, the [ISink](https://github.com/SteeltoeOSS/Steeltoe/blob/main/src/Stream/src/Abstractions/Messaging/ISink.cs) interface that defines an input channel.
340+
In the preceding application, the `[EnableBinding]` attribute indicates that you want to bind your application to the messaging middleware. The attribute takes one or more interfaces as a parameter, in this case, the [ISink](https://github.com/SteeltoeOSS/Steeltoe/blob/3.x/src/Stream/src/Abstractions/Messaging/ISink.cs) interface that defines an input channel.
341341

342342
The `[StreamListener]` attribute binds the application's `input` channel to the `process` method by converting the incoming JSON to a `UsageCostDetail` object.
343343

docs/docs/v3/tracing/distributed-tracing-exporting.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Exporting Distributed Traces
22

3-
Steeltoe is able to automatically configure several exporters provided by the [OpenTelemetry](https://opentelemetry.io) project, including [Zipkin](https://github.com/open-telemetry/opentelemetry-dotnet/tree/main/src/OpenTelemetry.Exporter.Zipkin), [Jaeger](https://github.com/open-telemetry/opentelemetry-dotnet/tree/main/src/OpenTelemetry.Exporter.Jaeger) and [OpenTelemetryProtocol](https://github.com/open-telemetry/opentelemetry-dotnet/tree/main/src/OpenTelemetry.Exporter.OpenTelemetryProtocol), if a NuGet reference to the desired exporter is included. The `Steeltoe.Management.ExporterBase` and `Steeltoe.Management.ExporterCore` packages are no longer required. In addition, Steeltoe supports exporting traces to [TanzuObservability](https://tanzu.vmware.com/observability) without any other NuGet references.
3+
Steeltoe is able to automatically configure several exporters provided by the [OpenTelemetry](https://opentelemetry.io) project, including [Zipkin](https://github.com/open-telemetry/opentelemetry-dotnet/tree/main/src/OpenTelemetry.Exporter.Zipkin), [Jaeger](https://github.com/open-telemetry/opentelemetry-dotnet/blob/main/docs/trace/getting-started-jaeger/README.md) and [OpenTelemetryProtocol](https://github.com/open-telemetry/opentelemetry-dotnet/tree/main/src/OpenTelemetry.Exporter.OpenTelemetryProtocol), if a NuGet reference to the desired exporter is included. The `Steeltoe.Management.ExporterBase` and `Steeltoe.Management.ExporterCore` packages are no longer required. In addition, Steeltoe supports exporting traces to [TanzuObservability](https://tanzu.vmware.com/observability) without any other NuGet references.
44

55
## Common Settings
66

0 commit comments

Comments
 (0)