Skip to content

Clarify Building & Running README sections, add clickable links #455

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
TimHess wants to merge 1 commit into
base: main
Choose a base branch
from
+16 −16
Open

Clarify Building & Running README sections, add clickable links #455

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 10 additions & 10 deletions Connectors/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.

---

Expand Down
4 changes: 2 additions & 2 deletions Discovery/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.

---

Expand Down
6 changes: 3 additions & 3 deletions Management/src/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.

---

Expand Down
2 changes: 1 addition & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.