From bf4321a5b180483df86f240a5758830810f9d30b Mon Sep 17 00:00:00 2001 From: Safia Abdalla Date: Fri, 13 Nov 2020 14:44:03 -0800 Subject: [PATCH 1/4] Add README to Html.Abstractions --- src/Html/Abstractions/README.md | 21 +++++++++++++++++++++ 1 file changed, 21 insertions(+) create mode 100644 src/Html/Abstractions/README.md diff --git a/src/Html/Abstractions/README.md b/src/Html/Abstractions/README.md new file mode 100644 index 000000000000..f06439a0ebcb --- /dev/null +++ b/src/Html/Abstractions/README.md @@ -0,0 +1,21 @@ +# Html.Abstractions + +This project contains types for manipulating HTML content. + +## Description + +This project contains interfaces and abstractions used in MVC to support writing and modifying HTML content. For a full list of the types defined in this class, see [the namespace documentation](https://docs.microsoft.com//dotnet/api/microsoft.aspnetcore.html). + +## Development Setup + +### 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/master/docs/BuildFromSource.md#building-a-subset-of-the-code). + +### Test + +To run the tests for this project, you can [run the tests on the command line](https://github.com/dotnet/aspnetcore/blob/master/docs/BuildFromSource.md#running-tests-on-command-line) in this directory. + +## More Information + +For more information, see the [ASP.NET Core README](../../README.md). From 28259c1b16f0406f4d153eb121aed80109b1f9ed Mon Sep 17 00:00:00 2001 From: Safia Abdalla Date: Tue, 17 Nov 2020 15:07:18 -0800 Subject: [PATCH 2/4] Address feedback from peer review --- src/Html/Abstractions/README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/src/Html/Abstractions/README.md b/src/Html/Abstractions/README.md index f06439a0ebcb..3381a14c47a3 100644 --- a/src/Html/Abstractions/README.md +++ b/src/Html/Abstractions/README.md @@ -10,12 +10,12 @@ This project contains interfaces and abstractions used in MVC to support writing ### 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/master/docs/BuildFromSource.md#building-a-subset-of-the-code). +To build this specific project from source, you can follow the instructions [on building a subset of the code](../../../BuildFromSource.md#building-a-subset-of-the-code). ### Test -To run the tests for this project, you can [run the tests on the command line](https://github.com/dotnet/aspnetcore/blob/master/docs/BuildFromSource.md#running-tests-on-command-line) in this directory. +To run the tests for this project, you can [run the tests on the command line](../../../BuildFromSource.md#running-tests-on-command-line) in this directory. ## More Information -For more information, see the [ASP.NET Core README](../../README.md). +For more information, see the [ASP.NET Core README](../../../README.md). From b07c3a4f478857ab78e2e69844805a12a5d55242 Mon Sep 17 00:00:00 2001 From: Safia Abdalla Date: Tue, 17 Nov 2020 15:07:36 -0800 Subject: [PATCH 3/4] Update build instructions for components project --- src/Components/README.md | 6 ++++-- src/Html/Abstractions/README.md | 2 +- 2 files changed, 5 insertions(+), 3 deletions(-) diff --git a/src/Components/README.md b/src/Components/README.md index 86b1fe0d152a..f9893b67af32 100644 --- a/src/Components/README.md +++ b/src/Components/README.md @@ -31,7 +31,9 @@ The following contains a description of each sub-directory in the `Components` d ### 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/master/docs/BuildFromSource.md#building-a-subset-of-the-code). +To build this specific project from source, you can follow the instructions [on building a subset of the code](../../BuildFromSource.md#building-a-subset-of-the-code). + +Note, you will also need to run the `build` command above in the command line before building in VS to ensure that the Web.JS dependency is built. ### Test @@ -46,7 +48,7 @@ The E2E tests are located in the top-level `tests` folder in this directory. The Each app server mounts the same `BasicTestApp` application under each scenario. -To run the tests for this project, you can [run the tests on the command line](https://github.com/dotnet/aspnetcore/blob/master/docs/BuildFromSource.md#running-tests-on-command-line) in this directory. +To run the tests for this project, you can [run the tests on the command line](../../BuildFromSource.md#running-tests-on-command-line) in this directory. ## More Information diff --git a/src/Html/Abstractions/README.md b/src/Html/Abstractions/README.md index 3381a14c47a3..8ebe6da239c4 100644 --- a/src/Html/Abstractions/README.md +++ b/src/Html/Abstractions/README.md @@ -4,7 +4,7 @@ This project contains types for manipulating HTML content. ## Description -This project contains interfaces and abstractions used in MVC to support writing and modifying HTML content. For a full list of the types defined in this class, see [the namespace documentation](https://docs.microsoft.com//dotnet/api/microsoft.aspnetcore.html). +This project contains interfaces and abstractions used in MVC to support writing and modifying HTML content. For a full list of the types defined in this class, see [the namespace documentation](https://docs.microsoft.com/dotnet/api/microsoft.aspnetcore.html). ## Development Setup From 90655a4ca891e52a29419eddf75c3caf2ad7b3dd Mon Sep 17 00:00:00 2001 From: Safia Abdalla Date: Wed, 18 Nov 2020 20:21:09 -0800 Subject: [PATCH 4/4] Apply suggestions from code review Co-authored-by: Rick Anderson <3605364+Rick-Anderson@users.noreply.github.com> --- src/Components/README.md | 6 +++--- src/Html/Abstractions/README.md | 4 ++-- 2 files changed, 5 insertions(+), 5 deletions(-) diff --git a/src/Components/README.md b/src/Components/README.md index f9893b67af32..57487d1bfdf9 100644 --- a/src/Components/README.md +++ b/src/Components/README.md @@ -31,9 +31,9 @@ The following contains a description of each sub-directory in the `Components` d ### Build -To build this specific project from source, you can 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 a subset of the code](../../BuildFromSource.md#building-a-subset-of-the-code). -Note, you will also need to run the `build` command above in the command line before building in VS to ensure that the Web.JS dependency is built. +**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. ### Test @@ -48,7 +48,7 @@ The E2E tests are located in the top-level `tests` folder in this directory. The Each app server mounts the same `BasicTestApp` application under each scenario. -To run the tests for this project, you can [run the tests on the command line](../../BuildFromSource.md#running-tests-on-command-line) in this directory. +To run the tests for this project, [run the tests on the command line](../../BuildFromSource.md#running-tests-on-command-line) in this directory. ## More Information diff --git a/src/Html/Abstractions/README.md b/src/Html/Abstractions/README.md index 8ebe6da239c4..88438f78a8ec 100644 --- a/src/Html/Abstractions/README.md +++ b/src/Html/Abstractions/README.md @@ -10,11 +10,11 @@ This project contains interfaces and abstractions used in MVC to support writing ### Build -To build this specific project from source, you can 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 a subset of the code](../../../BuildFromSource.md#building-a-subset-of-the-code). ### Test -To run the tests for this project, you can [run the tests on the command line](../../../BuildFromSource.md#running-tests-on-command-line) in this directory. +To run the tests for this project, [run the tests on the command line](../../../BuildFromSource.md#running-tests-on-command-line) in this directory. ## More Information