From 1b5576f64ddc024df7ef35b5a52649d8f0921c6c Mon Sep 17 00:00:00 2001 From: John Luo Date: Fri, 30 Apr 2021 22:08:27 -0700 Subject: [PATCH 1/3] Add Readme for Analyzers, ObjectPool and Identity --- src/Analyzers/Readme.md | 22 ++++++++++++++++++++++ src/Identity/README.md | 34 +++++++++++++++++++++++++++++++--- src/ObjectPool/Readme.md | 28 ++++++++++++++++++++++++++++ 3 files changed, 81 insertions(+), 3 deletions(-) create mode 100644 src/Analyzers/Readme.md create mode 100644 src/ObjectPool/Readme.md diff --git a/src/Analyzers/Readme.md b/src/Analyzers/Readme.md new file mode 100644 index 000000000000..65cadf15a795 --- /dev/null +++ b/src/Analyzers/Readme.md @@ -0,0 +1,22 @@ +# Object Pool + +This directory contains sources for analyers used internally by ASP.NET Core. + +## Description + +- `Analyzers`: Contains analyzers for ASP.NET Core shipped as part of the Microsoft.NET.Sdk.Web. +- `Microsoft.AspNetCore.Analyzer.Testing`: Contains types for writing analyzer tests. + +## Development Setup + +### Build + +To build this specific project from source, follow the instructions [on building the project](../../docs/BuildFromSource.md#step-3:-build-the-repo). + +### 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). \ No newline at end of file diff --git a/src/Identity/README.md b/src/Identity/README.md index 185b71f6261e..2beca49dc6e4 100644 --- a/src/Identity/README.md +++ b/src/Identity/README.md @@ -1,7 +1,35 @@ -ASP.NET Core Identity -===================== +# Identity -ASP.NET Core Identity is the membership system for building ASP.NET Core web applications, including membership, login, and user data. ASP.NET Core Identity allows you to add login features to your application and makes it easy to customize data about the logged in user. +ASP.NET Core Identity is the membership system for building ASP.NET Core web applications, including membership, login, and user data. ASP.NET Core Identity allows you to add login features to your application and makes it easy to customize data about the logged in user. You can find additional information in the [ASP.NET Core Documentation](https://docs.microsoft.com/en-us/aspnet/core/security/authentication/identity). + +## Description + +The following contains a description of each sub-directory in the `Identity` directory. + +- `ApiAuthorization.IdentityServer`: Contains IdentityServer based support for API Authorization. +- `Core`: Contains the main abstractions and types for providing support for Identity in ASP.NET Core applications. +- `EntityFrameworkCore`: Contains implementations for Identity stores based on EntityFrameworkCore. +- `Extensions.Core`: Contains the abstractions and types for general Identity concerns. +- `Extensions.Stores`: Contains abstractions and types for Identity storage providers. +- `samples`: Contains a collection of sample apps. +- `Specification.Tests`: Contains a test suite for ASP.NET Core Identity store implemenations. +- `test`: Contains the unit and functional tests for Microsoft.Extensions.Identity and Microsoft.AspNetCore.Identity components. +- `testassets`: Contains a webapp used for functional testing. +- `UI`: Contains compiled Razor UI components for use in ASP.NET Core Identity. + +## Development Setup + +### Build + +To build this specific project from source, follow the instructions [on building the project](../../docs/BuildFromSource.md#step-3:-build-the-repo). + +### 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). ## ASP.NET Identity for ASP.NET MVC 5 diff --git a/src/ObjectPool/Readme.md b/src/ObjectPool/Readme.md new file mode 100644 index 000000000000..3e24e8c97f65 --- /dev/null +++ b/src/ObjectPool/Readme.md @@ -0,0 +1,28 @@ +# Object Pool + +This directory contains sources for [`Microsoft.Extensions.ObjectPool`](https://www.nuget.org/packages/Microsoft.Extensions.ObjectPool). This package provides types that enable object reuse. You can find additional information in the [ASP.NET Core Documentation](https://docs.microsoft.com/en-us/aspnet/core/performance/objectpool). + +## Description + +This project contains abstractions and default implementations for pooling objects. Commonly used types include: + +`ObjectPool` - This represents a pool of objects. This is used to get and return pooled objects. +`IPooledObjectPolicy` = This policy defines how pooled objects are created and returned. +`ObjectPoolProvider` - This represents a provider of `ObjectPool`. This is used to create object pools based on an `IPooledObjectPolicy`. + + +For a full list of the types defined in this project, see [the namespace documentation](https://docs.microsoft.com/en-gb/dotnet/api/microsoft.extensions.objectpool). + +## Development Setup + +### Build + +To build this specific project from source, follow the instructions [on building the project](../../docs/BuildFromSource.md#step-3:-build-the-repo). + +### 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). \ No newline at end of file From ed771b1a7494c8b303cc8addc47f94d2e3136340 Mon Sep 17 00:00:00 2001 From: = Date: Sun, 2 May 2021 20:58:50 -0700 Subject: [PATCH 2/3] Cleanup --- src/Analyzers/Readme.md | 6 +++--- src/Identity/README.md | 4 ++-- src/ObjectPool/Readme.md | 10 +++++----- 3 files changed, 10 insertions(+), 10 deletions(-) diff --git a/src/Analyzers/Readme.md b/src/Analyzers/Readme.md index 65cadf15a795..3accf38136b7 100644 --- a/src/Analyzers/Readme.md +++ b/src/Analyzers/Readme.md @@ -1,4 +1,4 @@ -# Object Pool +# Analyzers This directory contains sources for analyers used internally by ASP.NET Core. @@ -11,7 +11,7 @@ This directory contains sources for analyers used internally by ASP.NET Core. ### Build -To build this specific project from source, follow the instructions [on building the project](../../docs/BuildFromSource.md#step-3:-build-the-repo). +To build this specific project from source, follow the instructions [on building the project](../../docs/BuildFromSource.md#step-3-build-the-repo). ### Test @@ -19,4 +19,4 @@ 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). \ No newline at end of file +For more information, see the [ASP.NET Core README](../../README.md). diff --git a/src/Identity/README.md b/src/Identity/README.md index 2beca49dc6e4..b83c09070c04 100644 --- a/src/Identity/README.md +++ b/src/Identity/README.md @@ -1,6 +1,6 @@ # Identity -ASP.NET Core Identity is the membership system for building ASP.NET Core web applications, including membership, login, and user data. ASP.NET Core Identity allows you to add login features to your application and makes it easy to customize data about the logged in user. You can find additional information in the [ASP.NET Core Documentation](https://docs.microsoft.com/en-us/aspnet/core/security/authentication/identity). +ASP.NET Core Identity is the membership system for building ASP.NET Core web applications, including membership, login, and user data. ASP.NET Core Identity allows you to add login features to your application and makes it easy to customize data about the logged in user. You can find additional information in the [ASP.NET Core Documentation](https://docs.microsoft.com/aspnet/core/security/authentication/identity). ## Description @@ -21,7 +21,7 @@ The following contains a description of each sub-directory in the `Identity` dir ### Build -To build this specific project from source, follow the instructions [on building the project](../../docs/BuildFromSource.md#step-3:-build-the-repo). +To build this specific project from source, follow the instructions [on building the project](../../docs/BuildFromSource.md#step-3-build-the-repo). ### Test diff --git a/src/ObjectPool/Readme.md b/src/ObjectPool/Readme.md index 3e24e8c97f65..7ca3a5b9244f 100644 --- a/src/ObjectPool/Readme.md +++ b/src/ObjectPool/Readme.md @@ -1,23 +1,23 @@ # Object Pool -This directory contains sources for [`Microsoft.Extensions.ObjectPool`](https://www.nuget.org/packages/Microsoft.Extensions.ObjectPool). This package provides types that enable object reuse. You can find additional information in the [ASP.NET Core Documentation](https://docs.microsoft.com/en-us/aspnet/core/performance/objectpool). +This directory contains sources for [`Microsoft.Extensions.ObjectPool`](https://www.nuget.org/packages/Microsoft.Extensions.ObjectPool). This package provides types that enable object reuse. You can find additional information in the [ASP.NET Core Documentation](https://docs.microsoft.com/aspnet/core/performance/objectpool). ## Description This project contains abstractions and default implementations for pooling objects. Commonly used types include: `ObjectPool` - This represents a pool of objects. This is used to get and return pooled objects. -`IPooledObjectPolicy` = This policy defines how pooled objects are created and returned. +`IPooledObjectPolicy` - This policy defines how pooled objects are created and returned. `ObjectPoolProvider` - This represents a provider of `ObjectPool`. This is used to create object pools based on an `IPooledObjectPolicy`. -For a full list of the types defined in this project, see [the namespace documentation](https://docs.microsoft.com/en-gb/dotnet/api/microsoft.extensions.objectpool). +For a full list of the types defined in this project, see [the namespace documentation](https://docs.microsoft.com/dotnet/api/microsoft.extensions.objectpool). ## Development Setup ### Build -To build this specific project from source, follow the instructions [on building the project](../../docs/BuildFromSource.md#step-3:-build-the-repo). +To build this specific project from source, follow the instructions [on building the project](../../docs/BuildFromSource.md#step-3-build-the-repo). ### Test @@ -25,4 +25,4 @@ 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). \ No newline at end of file +For more information, see the [ASP.NET Core README](../../README.md). From 44bc8457683530a48b74bb54fb1fde65d9c8af3c Mon Sep 17 00:00:00 2001 From: John Luo Date: Tue, 4 May 2021 10:03:29 -0700 Subject: [PATCH 3/3] Update link to BuildFromSource.md --- src/Caching/README.md | 2 +- src/Components/README.md | 2 +- src/DataProtection/README.md | 2 +- src/Framework/README.md | 2 +- src/Hosting/README.md | 2 +- src/Html.Abstractions/README.md | 2 +- src/Http/README.md | 2 +- src/HttpClientFactory/README.md | 2 +- src/JSInterop/README.md | 2 +- src/Servers/HttpSys/README.md | 2 +- src/Servers/IIS/README.md | 2 +- src/Servers/Kestrel/README.md | 2 +- src/SignalR/README.md | 2 +- src/SiteExtensions/README.md | 2 +- 14 files changed, 14 insertions(+), 14 deletions(-) diff --git a/src/Caching/README.md b/src/Caching/README.md index 55ae76e849d3..038a27e56b0c 100644 --- a/src/Caching/README.md +++ b/src/Caching/README.md @@ -10,7 +10,7 @@ These packages are not part of the ASP.NET Core shared framework but are shipped ### 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). +To build this specific project from source, follow the instructions [on building the project](../../docs/BuildFromSource.md#step-3-build-the-repo). ### Test diff --git a/src/Components/README.md b/src/Components/README.md index 110010638db5..2ecd7683757a 100644 --- a/src/Components/README.md +++ b/src/Components/README.md @@ -31,7 +31,7 @@ The following contains a description of each sub-directory in the `Components` d ### 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). +To build this specific project from source, follow the instructions [on building the project](../../docs/BuildFromSource.md#step-3-build-the-repo). **Note:** You also need to run the preceding `build` command in the command line before building in VS to ensure that the Web.JS dependency is built. diff --git a/src/DataProtection/README.md b/src/DataProtection/README.md index 09f9b50c85ce..746442953465 100644 --- a/src/DataProtection/README.md +++ b/src/DataProtection/README.md @@ -20,7 +20,7 @@ The following contains a description of each sub-directory in the `DataProtectio ### 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). +To build this specific project from source, follow the instructions [on building the project](../../docs/BuildFromSource.md#step-3-build-the-repo). ### Test diff --git a/src/Framework/README.md b/src/Framework/README.md index fee851bba1c0..c54864a40334 100644 --- a/src/Framework/README.md +++ b/src/Framework/README.md @@ -14,7 +14,7 @@ The following contains a description of each sub-directory in the `Framework` di ### 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). +To build this specific project from source, follow the instructions [on building the project](../../docs/BuildFromSource.md#step-3-build-the-repo). ### Test diff --git a/src/Hosting/README.md b/src/Hosting/README.md index 4b3b79ec03bf..d76721b5288b 100644 --- a/src/Hosting/README.md +++ b/src/Hosting/README.md @@ -20,7 +20,7 @@ The following contains a description of the sub-directories. ### Build -To build this specific project from source, you can follow the instructions [on building a subset of the code](../../docs/BuildFromSource.md#building-a-subset-of-the-code). +To build this specific project from source, follow the instructions [on building the project](../../docs/BuildFromSource.md#step-3-build-the-repo). ### Test diff --git a/src/Html.Abstractions/README.md b/src/Html.Abstractions/README.md index 88438f78a8ec..7c524b1dfedb 100644 --- a/src/Html.Abstractions/README.md +++ b/src/Html.Abstractions/README.md @@ -10,7 +10,7 @@ This project contains interfaces and abstractions used in MVC to support writing ### Build -To build this specific project from source, follow the instructions [on building a subset of the code](../../../BuildFromSource.md#building-a-subset-of-the-code). +To build this specific project from source, follow the instructions [on building the project](../../docs/BuildFromSource.md#step-3-build-the-repo). ### Test diff --git a/src/Http/README.md b/src/Http/README.md index 4f614ed4cd59..e7f09db1a7fb 100644 --- a/src/Http/README.md +++ b/src/Http/README.md @@ -26,7 +26,7 @@ The following contains a description of each sub-directory in the `Http` directo ### 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). +To build this specific project from source, follow the instructions [on building the project](../../docs/BuildFromSource.md#step-3-build-the-repo). ### Test diff --git a/src/HttpClientFactory/README.md b/src/HttpClientFactory/README.md index fb14f0beee75..44ac49de8d06 100644 --- a/src/HttpClientFactory/README.md +++ b/src/HttpClientFactory/README.md @@ -10,7 +10,7 @@ These packages are not part of the ASP.NET Core shared framework but are shipped ### 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). +To build this specific project from source, follow the instructions [on building the project](../../docs/BuildFromSource.md#step-3-build-the-repo). ### Test diff --git a/src/JSInterop/README.md b/src/JSInterop/README.md index 44311490dc90..4e772f743e44 100644 --- a/src/JSInterop/README.md +++ b/src/JSInterop/README.md @@ -29,7 +29,7 @@ Since `Microsoft.JSInterop.JS` is platform-independent, runtime environments suc To build the .NET code, you can: - * Run `dotnet build` in the `Microsoft.JSInterop/src` directory. You can also read more [on building a subset of the code](../../docs/BuildFromSource.md#building-a-subset-of-the-code). + * Run `dotnet build` in the `Microsoft.JSInterop/src` directory. You can also read more [on building the project](../../docs/BuildFromSource.md#step-3-build-the-repo). * Run `dotnet build` or `dotnet test` in the `Microsoft.JSInterop/test` directory. You can also read more about how to [run the tests on the command line](../../docs/BuildFromSource.md#running-tests-on-command-line). Alternatively, open `JSInterop.slnf` in Visual Studio. diff --git a/src/Servers/HttpSys/README.md b/src/Servers/HttpSys/README.md index e51c8b2fad50..dd500d286527 100644 --- a/src/Servers/HttpSys/README.md +++ b/src/Servers/HttpSys/README.md @@ -19,7 +19,7 @@ This folder contains all relevant code for the HttpSys Web Server implementation HTTP.sys can only be used on Windows. -To build this specific project from source, you can follow the instructions [on building a subset of the code](https://github.com/dotnet/aspnetcore/blob/main/docs/BuildFromSource.md#building-a-subset-of-the-code). +To build this specific project from source, follow the instructions [on building the project](../../../docs/BuildFromSource.md#step-3-build-the-repo). Or for the less detailed explanation, run the following command inside this directory. ```powershell diff --git a/src/Servers/IIS/README.md b/src/Servers/IIS/README.md index abd9ca262e62..a1f03970e730 100644 --- a/src/Servers/IIS/README.md +++ b/src/Servers/IIS/README.md @@ -32,7 +32,7 @@ IIS can only be used on Windows. IIS requires VS C++ native components to build. VS C++ native components can be installed by following the [Build From Source instructions](https://github.com/dotnet/aspnetcore/blob/main/docs/BuildFromSource.md#on-windows). -To build this specific project from source, you can follow the instructions [on building a subset of the code](https://github.com/dotnet/aspnetcore/blob/main/docs/BuildFromSource.md#building-a-subset-of-the-code). +To build this specific project from source, follow the instructions [on building the project](../../../docs/BuildFromSource.md#step-3-build-the-repo). Or for the less detailed explanation, run the following command inside this directory. ```powershell diff --git a/src/Servers/Kestrel/README.md b/src/Servers/Kestrel/README.md index f38718cd006e..4c20458da128 100644 --- a/src/Servers/Kestrel/README.md +++ b/src/Servers/Kestrel/README.md @@ -19,7 +19,7 @@ The following contains a description of the sub-directories. ### Build -To build this specific project from source, you can follow the instructions [on building a subset of the code](https://github.com/dotnet/aspnetcore/blob/main/docs/BuildFromSource.md#building-a-subset-of-the-code). +To build this specific project from source, follow the instructions [on building the project](../../../docs/BuildFromSource.md#step-3-build-the-repo). Or for the less detailed explanation, run the following command inside this directory. ```powershell diff --git a/src/SignalR/README.md b/src/SignalR/README.md index 8ceef4c0ee7a..a68e4c654e96 100644 --- a/src/SignalR/README.md +++ b/src/SignalR/README.md @@ -32,7 +32,7 @@ The following contains a description of the sub-directories. By default, the build script will try to build Java and Typescript projects. If you don't want to include those, you can pass "-NoBuildJava" and "-NoBuildNodeJS" respectively to the build script to skip them. Or "--no-build-java" and "--no-build-nodejs" on MacOS or Linux. -To build this specific project from source, you can follow the instructions [on building a subset of the code](https://github.com/dotnet/aspnetcore/blob/main/docs/BuildFromSource.md#building-a-subset-of-the-code). +To build this specific project from source, follow the instructions [on building the project](../../docs/BuildFromSource.md#step-3-build-the-repo). Or for the less detailed explanation, run the following command inside this directory. ```powershell diff --git a/src/SiteExtensions/README.md b/src/SiteExtensions/README.md index 1ac68b566fe4..9b23d1b39660 100644 --- a/src/SiteExtensions/README.md +++ b/src/SiteExtensions/README.md @@ -14,7 +14,7 @@ The following contains a description of each sub-directory in the `SiteExtension ### 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). +To build this specific project from source, follow the instructions [on building the project](../../docs/BuildFromSource.md#step-3-build-the-repo). Or for the less detailed explanation, run the following command inside this directory. ```powershell