From 9a411b18c3a58fc71788d3cdb69ebc79d42d9d40 Mon Sep 17 00:00:00 2001 From: Justin Kotalik Date: Thu, 25 Mar 2021 13:16:26 -0700 Subject: [PATCH 1/2] Readmes for HTTP and Site Extensions --- src/Http/README.md | 40 ++++++++++++++++++++++++++++++++---- src/SiteExtensions/README.md | 26 +++++++++++++++++++++++ 2 files changed, 62 insertions(+), 4 deletions(-) create mode 100644 src/SiteExtensions/README.md diff --git a/src/Http/README.md b/src/Http/README.md index 58e2500a02c8..a259d40e1ea3 100644 --- a/src/Http/README.md +++ b/src/Http/README.md @@ -1,6 +1,38 @@ -Http Abstractions -================= +# Http -This folders contains projects for HTTP abstractions for ASP.NET Core such as `HttpContext`, `HttpRequest`, `HttpResponse` and `RequestDelegate`. +Http is a collection of HTTP abstractions used in ASP.NET Core, such as `HttpContext`, `HttpRequest`, `HttpResponse` and `RequestDelegate`. + +It also includes `Endpoint Routing` and `WebUtilities`. + +## Description + +The following contains a description of each sub-directory in the `DataProtection` directory. + +- [Authentication.Abstractions/](Authentication.Abstractions/): Contains common types used by the various authentication components. +- [Authentication.Core/](Authentication.Core/): Contains common types used by the various authentication middleware components. +- [Headers/](Headers/): Contains headers and header parser implementations. +- [Http/](Http/): Contains default HTTP feature implementations. +- [Http.Abstractions/](Http.Abstractions/): Contains HTTP object model for HTTP requests and responses and also common extension methods for registering middleware in an IApplicationBuilder. +- [Http.Extensions/](Http.Extensions/):Contains common extension methods for HTTP abstractions, HTTP headers, HTTP request/response, and session state. +- [Http.Features/](Http.Features/): Contains HTTP feature interface definitions. +- [Metadata/](Metadata/): Contains ASP.NET Core metadata. +- [Owin/](Owin/): Contains component for running OWIN middleware in an ASP.NET Core application, and to run ASP.NET Core middleware in an OWIN application. +- [Routing/](Routing/): Contains middleware for routing requests to application logic and for generating links. +- [Routing.Abstractions/](Routing.Abstractions/): Contains abstractions for routing requests to application logic and for generating links. +- [WebUtilities/](WebUtilities/): Contains utilities, such as for working with forms, multipart messages, and query strings. +- [samples/](samples/): Contains samples. + +## Development Setup + +### Build + +To build this specific project from source, follow the instructions [on building a subset of the code](../../docs/BuildFromSource.md#building-a-subset-of-the-code). + +### Test + +To run the tests for this project, [run the tests on the command line](../../docs/BuildFromSource.md#running-tests-on-command-line) in this directory. + +## More Information + +For more information, see the [ASP.NET Core README](../../README.md). -It also contains `IApplicationBuilder` and extensions to create and compose your application's pipeline. diff --git a/src/SiteExtensions/README.md b/src/SiteExtensions/README.md new file mode 100644 index 000000000000..1ac68b566fe4 --- /dev/null +++ b/src/SiteExtensions/README.md @@ -0,0 +1,26 @@ +# SiteExtensions + +Site extensions are extensions specific to Azure App Services. + +## Description + +The following contains a description of each sub-directory in the `SiteExtensions` directory. + +- `LoggingAggregate`: Site extensions for logging integration for ASP.NET Core applications on Azure App Service. +- `LoggingBranch`: Site extension which enables additional functionality for ASP.NET Core on Azure WebSites, such as enabling Azure logging. +- `Runtime`: This site extension installs Microsoft.AspNetCore.App and Microsoft.NetCore.App shared runtimes. + +## Development Setup + +### Build + +To build this specific project from source, follow the instructions [on building a subset of the code](../../docs/BuildFromSource.md#building-a-subset-of-the-code). + +Or for the less detailed explanation, run the following command inside this directory. +```powershell +> ./build.cmd +``` + +## More Information + +For more information, see the [ASP.NET Core README](../../README.md). From 002aed43f4f6cab3f7ab57139e93b5b90d43f7ee Mon Sep 17 00:00:00 2001 From: Justin Kotalik Date: Thu, 25 Mar 2021 13:39:22 -0700 Subject: [PATCH 2/2] Apply suggestions from code review Co-authored-by: Brennan --- src/Http/README.md | 9 ++++----- 1 file changed, 4 insertions(+), 5 deletions(-) diff --git a/src/Http/README.md b/src/Http/README.md index a259d40e1ea3..4f614ed4cd59 100644 --- a/src/Http/README.md +++ b/src/Http/README.md @@ -6,20 +6,20 @@ It also includes `Endpoint Routing` and `WebUtilities`. ## Description -The following contains a description of each sub-directory in the `DataProtection` directory. +The following contains a description of each sub-directory in the `Http` directory. - [Authentication.Abstractions/](Authentication.Abstractions/): Contains common types used by the various authentication components. - [Authentication.Core/](Authentication.Core/): Contains common types used by the various authentication middleware components. - [Headers/](Headers/): Contains headers and header parser implementations. - [Http/](Http/): Contains default HTTP feature implementations. - [Http.Abstractions/](Http.Abstractions/): Contains HTTP object model for HTTP requests and responses and also common extension methods for registering middleware in an IApplicationBuilder. -- [Http.Extensions/](Http.Extensions/):Contains common extension methods for HTTP abstractions, HTTP headers, HTTP request/response, and session state. +- [Http.Extensions/](Http.Extensions/): Contains common extension methods for HTTP abstractions, HTTP headers, HTTP request/response, and session state. - [Http.Features/](Http.Features/): Contains HTTP feature interface definitions. - [Metadata/](Metadata/): Contains ASP.NET Core metadata. -- [Owin/](Owin/): Contains component for running OWIN middleware in an ASP.NET Core application, and to run ASP.NET Core middleware in an OWIN application. +- [Owin/](Owin/): Contains components for running OWIN middleware in an ASP.NET Core application, and to run ASP.NET Core middleware in an OWIN application. - [Routing/](Routing/): Contains middleware for routing requests to application logic and for generating links. - [Routing.Abstractions/](Routing.Abstractions/): Contains abstractions for routing requests to application logic and for generating links. -- [WebUtilities/](WebUtilities/): Contains utilities, such as for working with forms, multipart messages, and query strings. +- [WebUtilities/](WebUtilities/): Contains utilities, for working with forms, multipart messages, and query strings. - [samples/](samples/): Contains samples. ## Development Setup @@ -35,4 +35,3 @@ To run the tests for this project, [run the tests on the command line](../../doc ## More Information For more information, see the [ASP.NET Core README](../../README.md). -