From a5259cc6a7197c0236fa90a5739f805bb52881f0 Mon Sep 17 00:00:00 2001 From: Tim Hess Date: Mon, 20 Apr 2026 14:01:01 -0500 Subject: [PATCH] Clarify Building & Running sections, add clickable links to other READMEs --- Connectors/README.md | 20 ++++++++++---------- Discovery/README.md | 4 ++-- Management/src/README.md | 6 +++--- README.md | 2 +- 4 files changed, 16 insertions(+), 16 deletions(-) diff --git a/Connectors/README.md b/Connectors/README.md index b158a6f90..f34c0e2c7 100644 --- a/Connectors/README.md +++ b/Connectors/README.md @@ -5,19 +5,19 @@ Steeltoe Connectors simplify the coding process of binding to and accessing Clou ## ASP.NET Core Samples -* src/CosmosDb - Connect to an Azure CosmosDB database on Cloud Foundry. -* src/MongoDb - Connect to a MongoDB database on Cloud Foundry or Kubernetes. -* src/MySql - Connect to a MySQL database on Cloud Foundry or Kubernetes. -* src/MySqlEFCore - Connect to a MySQL database through an Entity Framework Core `DbContext` on Cloud Foundry or Kubernetes. -* src/PostgreSql - Connect to a PostgreSQL database on Cloud Foundry or Kubernetes. -* src/PostgreSqlEFCore - Connect to a PostgreSQL database through an Entity Framework Core `DbContext` on Cloud Foundry or Kubernetes. -* src/RabbitMQ - Connect to a RabbitMQ server on Cloud Foundry or Kubernetes. -* src/Redis - Connect to a Redis cache on Cloud Foundry or Kubernetes and configure [IDistributedCache](https://www.nuget.org/packages/Microsoft.Extensions.Caching.Redis). -* src/SqlServerEFCore - Connect to a Microsoft SQL Server database through an Entity Framework Core `DbContext` on Cloud Foundry. +* [CosmosDb](src/CosmosDb/README.md) - Connect to an Azure CosmosDB database on Cloud Foundry. +* [MongoDb](src/MongoDb/README.md) - Connect to a MongoDB database on Cloud Foundry or Kubernetes. +* [MySql](src/MySql/README.md) - Connect to a MySQL database on Cloud Foundry or Kubernetes. +* [MySqlEFCore](src/MySqlEFCore/README.md) - Connect to a MySQL database through an Entity Framework Core `DbContext` on Cloud Foundry or Kubernetes. +* [PostgreSql](src/PostgreSql/README.md) - Connect to a PostgreSQL database on Cloud Foundry or Kubernetes. +* [PostgreSqlEFCore](src/PostgreSqlEFCore/README.md) - Connect to a PostgreSQL database through an Entity Framework Core `DbContext` on Cloud Foundry or Kubernetes. +* [RabbitMQ](src/RabbitMQ/README.md) - Connect to a RabbitMQ server on Cloud Foundry or Kubernetes. +* [Redis](src/Redis/README.md) - Connect to a Redis cache on Cloud Foundry or Kubernetes and configure [IDistributedCache](https://www.nuget.org/packages/Microsoft.Extensions.Caching.Redis). +* [SqlServerEFCore](src/SqlServerEFCore/README.md) - Connect to a Microsoft SQL Server database through an Entity Framework Core `DbContext` on Cloud Foundry. ## Building & Running -See the Readme for instructions on building and running each app. +See the individual sample READMEs linked above for instructions on building and running each app. --- diff --git a/Discovery/README.md b/Discovery/README.md index cbe235494..bb9256c41 100644 --- a/Discovery/README.md +++ b/Discovery/README.md @@ -2,11 +2,11 @@ This repo tree contains sample apps illustrating how to use the [Steeltoe Discovery](https://github.com/SteeltoeOSS/Steeltoe/tree/main/src/Discovery) packages. -* src/FortuneTeller - ASP.NET microservice with MVC app, illustrating how to register and consume services using .NET configuration, Consul and Eureka. +* [FortuneTeller](src/FortuneTeller/README.md) - ASP.NET microservice with MVC app, illustrating how to register and consume services using .NET configuration, Consul and Eureka. ## Building & Running -See the readme for instructions on building and running each app. +See the individual sample READMEs linked above for instructions on building and running each app. --- diff --git a/Management/src/README.md b/Management/src/README.md index b3770c2de..34e509320 100644 --- a/Management/src/README.md +++ b/Management/src/README.md @@ -6,12 +6,12 @@ The endpoints also seamlessly integrate with [Tanzu Apps Manager](https://techdo ## ASP.NET Core Samples -* src/ActuatorWeb - use Management Endpoints and distributed tracing. Some functionality depends on ActuatorApi. -* src/ActuatorApi - use Management Endpoints, Management Tasks and distributed tracing. +* [ActuatorWeb](ActuatorWeb/README.md) - use Management Endpoints and distributed tracing. Some functionality depends on ActuatorApi. +* [ActuatorApi](ActuatorApi/README.md) - use Management Endpoints, Management Tasks and distributed tracing. ## Building & Running -See the Readme for instructions on building and running each app. +See the individual sample READMEs linked above for instructions on building and running each app. --- diff --git a/README.md b/README.md index 801cb9d59..3ab3cbb6c 100644 --- a/README.md +++ b/README.md @@ -36,4 +36,4 @@ If you are looking for documentation on how to use the Steeltoe components, you # Building & Running -See the Readmes for each sample for instructions on how to build and run. +See the individual sample READMEs linked above for instructions on how to build and run each specific application.