Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
22 changes: 22 additions & 0 deletions src/Analyzers/Readme.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
# Analyzers

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).
2 changes: 1 addition & 1 deletion src/Caching/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

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

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

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

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

Expand Down
2 changes: 1 addition & 1 deletion src/Html.Abstractions/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

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

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

Expand Down
34 changes: 31 additions & 3 deletions src/Identity/README.md
Original file line number Diff line number Diff line change
@@ -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/aspnet/core/security/authentication/identity).
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Are we still saying ASP.NET Core web applications?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

shrug only .NET got rebranded, not ASP.NET Core.


## 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

Expand Down
2 changes: 1 addition & 1 deletion src/JSInterop/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
28 changes: 28 additions & 0 deletions src/ObjectPool/Readme.md
Original file line number Diff line number Diff line change
@@ -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/aspnet/core/performance/objectpool).

## Description

This project contains abstractions and default implementations for pooling objects. Commonly used types include:

`ObjectPool<T>` - This represents a pool of objects. This is used to get and return pooled objects.
`IPooledObjectPolicy<T>` - This policy defines how pooled objects are created and returned.
`ObjectPoolProvider` - This represents a provider of `ObjectPool<T>`. This is used to create object pools based on an `IPooledObjectPolicy<T>`.


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).

### 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).
2 changes: 1 addition & 1 deletion src/Servers/HttpSys/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion src/Servers/IIS/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion src/Servers/Kestrel/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion src/SignalR/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion src/SiteExtensions/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down