From 86c2fc6628f33ffb29c5c5778a273c14a057ccad Mon Sep 17 00:00:00 2001 From: Sophia Favro Date: Tue, 22 Jun 2021 14:51:24 -0700 Subject: [PATCH 1/5] Added warning to let package owners know that the package description is in the README tab of their package if it has no README --- src/NuGetGallery/Views/Packages/DisplayPackageV2.cshtml | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/src/NuGetGallery/Views/Packages/DisplayPackageV2.cshtml b/src/NuGetGallery/Views/Packages/DisplayPackageV2.cshtml index 2febe139c8..296e47f660 100644 --- a/src/NuGetGallery/Views/Packages/DisplayPackageV2.cshtml +++ b/src/NuGetGallery/Views/Packages/DisplayPackageV2.cshtml @@ -543,6 +543,10 @@ } else if (!Model.Deleted && !String.IsNullOrWhiteSpace(Model.Description)) { + if (Model.CanDisplayPrivateMetadata) + { + @ViewHelpers.AlertWarning(@This package does not have a README, the package description is shown instead.); + }

@Html.PreFormattedText(Model.Description, Config)

} From 57fdf265abcbf6df821402a97333bdac89877531 Mon Sep 17 00:00:00 2001 From: Sophia Favro Date: Wed, 23 Jun 2021 14:24:18 -0700 Subject: [PATCH 2/5] changed the wording and linked to docs on readme practices --- src/NuGetGallery/Views/Packages/DisplayPackageV2.cshtml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/NuGetGallery/Views/Packages/DisplayPackageV2.cshtml b/src/NuGetGallery/Views/Packages/DisplayPackageV2.cshtml index 296e47f660..dc83789107 100644 --- a/src/NuGetGallery/Views/Packages/DisplayPackageV2.cshtml +++ b/src/NuGetGallery/Views/Packages/DisplayPackageV2.cshtml @@ -545,7 +545,7 @@ { if (Model.CanDisplayPrivateMetadata) { - @ViewHelpers.AlertWarning(@This package does not have a README, the package description is shown instead.); + @ViewHelpers.AlertWarning(@The package description is shown below. To display a README instead, please follow instructions found here.); }

@Html.PreFormattedText(Model.Description, Config)

} From 4c66c74206f4eceb2661a6d29a246006ed982bbc Mon Sep 17 00:00:00 2001 From: Sophia Favro Date: Thu, 24 Jun 2021 11:33:38 -0700 Subject: [PATCH 3/5] added line for styling purposes --- src/NuGetGallery/Views/Packages/DisplayPackageV2.cshtml | 1 + 1 file changed, 1 insertion(+) diff --git a/src/NuGetGallery/Views/Packages/DisplayPackageV2.cshtml b/src/NuGetGallery/Views/Packages/DisplayPackageV2.cshtml index dc83789107..6037c9e4f4 100644 --- a/src/NuGetGallery/Views/Packages/DisplayPackageV2.cshtml +++ b/src/NuGetGallery/Views/Packages/DisplayPackageV2.cshtml @@ -547,6 +547,7 @@ { @ViewHelpers.AlertWarning(@The package description is shown below. To display a README instead, please follow instructions found here.); } +

@Html.PreFormattedText(Model.Description, Config)

} From a199b2c78f3b22db1b5e649e8036d0528016d226 Mon Sep 17 00:00:00 2001 From: Sophia Favro Date: Thu, 24 Jun 2021 15:21:19 -0700 Subject: [PATCH 4/5] changed wording to meet styling standards --- src/NuGetGallery/Views/Packages/DisplayPackageV2.cshtml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/NuGetGallery/Views/Packages/DisplayPackageV2.cshtml b/src/NuGetGallery/Views/Packages/DisplayPackageV2.cshtml index 6037c9e4f4..47833ef673 100644 --- a/src/NuGetGallery/Views/Packages/DisplayPackageV2.cshtml +++ b/src/NuGetGallery/Views/Packages/DisplayPackageV2.cshtml @@ -545,7 +545,7 @@ { if (Model.CanDisplayPrivateMetadata) { - @ViewHelpers.AlertWarning(@The package description is shown below. To display a README instead, please follow instructions found here.); + @ViewHelpers.AlertWarning(@The package description is shown below. To display a README instead, please follow these instructions.); }

@Html.PreFormattedText(Model.Description, Config)

From 38c325dfb34eb837dd2ef989d303c180e4e2987b Mon Sep 17 00:00:00 2001 From: Sophia Favro Date: Thu, 24 Jun 2021 16:57:53 -0700 Subject: [PATCH 5/5] improved message to make sense without links --- src/NuGetGallery/Views/Packages/DisplayPackageV2.cshtml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/NuGetGallery/Views/Packages/DisplayPackageV2.cshtml b/src/NuGetGallery/Views/Packages/DisplayPackageV2.cshtml index 47833ef673..0cccf2ecbd 100644 --- a/src/NuGetGallery/Views/Packages/DisplayPackageV2.cshtml +++ b/src/NuGetGallery/Views/Packages/DisplayPackageV2.cshtml @@ -545,7 +545,7 @@ { if (Model.CanDisplayPrivateMetadata) { - @ViewHelpers.AlertWarning(@The package description is shown below. To display a README instead, please follow these instructions.); + @ViewHelpers.AlertWarning(@The package description is shown below. Please update your package to include a README.); }

@Html.PreFormattedText(Model.Description, Config)