Skip to content

Commit 68b85b7

Browse files
authored
Miscellaneous build validation warnings and suggestions (#3139)
* fixed suggestions * fixes a few misses * Misc build warnings and suggestions * incorporated feedback
1 parent 153d63d commit 68b85b7

File tree

10 files changed

+16
-16
lines changed

10 files changed

+16
-16
lines changed

docs/create-packages/Creating-a-Package.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
title: Create a NuGet package using nuget.exe CLI
33
description: A detailed guide on designing and creating a NuGet package, including files and versioning.
44
author: JonDouglas
5-
ms.author: feaguila
5+
ms.author: jodou
66
ms.date: 07/14/2022
77
ms.topic: conceptual
88
---

docs/create-packages/Package-authoring-best-practices.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -124,8 +124,8 @@ Example: Copyright (c) Contoso 2020
124124
❌ DO NOT use the deprecated `IconUrl` metadata property.
125125

126126
### README
127-
✔️ DO [add a README markdown file](https://learn.microsoft.com/nuget/reference/msbuild-targets#packagereadmefile) that provides an overview of what your package does and how to get started.
128-
> A package README will significantly improve the quality perception of your package as well as new user onboarding. Also consider [previewing your README](../nuget-org/package-readme-on-nuget-org.md#preview-your-readme) before you upload it! See [how to include a README file in your NuGet package](https://learn.microsoft.com/nuget/reference/msbuild-targets#packagereadmefile) for more details.
127+
✔️ DO [add a README markdown file](/nuget/reference/msbuild-targets#packagereadmefile) that provides an overview of what your package does and how to get started.
128+
> A package README will significantly improve the quality perception of your package as well as new user onboarding. Also consider [previewing your README](../nuget-org/package-readme-on-nuget-org.md#preview-your-readme) before you upload it! See [how to include a README file in your NuGet package](/nuget/reference/msbuild-targets#packagereadmefile) for more details.
129129
130130
### Repository Type and URL
131131

docs/nuget-org/nuget-org-faq.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -236,7 +236,7 @@ sections:
236236
> [!Important]
237237
> - The old username will still be **reserved**. You will not be able to reuse the old username again and **this includes the change of casings**.
238238
> - As a consequence of the above, we will not be able to revert this change either.
239-
> - Any links to your old username profile page (e.g. https://www.nuget.org/profiles/OldUsername) will not be redirected to your new profile.
239+
> - Any links to your old username profile page (e.g. ```https://www.nuget.org/profiles/OldUsername```) will not be redirected to your new profile.
240240
> - Package versions currently owned by your account will still contain the old username in the repository signature. New package versions will contain the new username.
241241
> - Any author-provided metadata in the existing package versions referring to the old username or other identifying information will not be changed.
242242
> - NuGet client policies asserting trust of your old username will not implicitly trust packages published by your new username. Package consumers with these client policies configured will need to manual update them to trust your new username when they attempt to update to a newly published package version.

docs/nuget-org/policies/deleting-packages.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -46,6 +46,6 @@ Steps to unlist a package:
4646
1. Expand the "Listing" section and select the package version
4747
1. Uncheck “List in search results” and select "Save"
4848

49-
The specific package version has now been unlisted. In order to verify this, logout of your account and navigate to the package page (without the version part) e.g.: https://www.nuget.org/packages/YOUR-PACKAGE-NAME/. You will see all versions of that package that have **not** been unlisted. However, the package owner, when logged in, can see all versions and their listing status.
49+
The specific package version has now been unlisted. In order to verify this, logout of your account and navigate to the package page (without the version part) e.g.: ```https://www.nuget.org/packages/YOUR-PACKAGE-NAME/```. You will see all versions of that package that have **not** been unlisted. However, the package owner, when logged in, can see all versions and their listing status.
5050

5151
It's also possible to deprecate a package version (in case you can't delete a package version). For more information about deprecating package versions, see [Deprecating packages](../deprecate-packages.md).

docs/policies/Ecosystem.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ All of these projects are able to innovate because of developer contributions. J
1717

1818
## .NET Foundation projects
1919

20-
NuGet provides a free, open source package management system for the Microsoft development platform. It consists of a few client tools as well as the set of services that comprise the [official NuGet Gallery](http://www.nuget.org). Combined, these form the NuGet project which is governed by the [.NET Foundation](http://www.dotnetfoundation.org/).
20+
NuGet provides a free, open source package management system for the Microsoft development platform. It consists of a few client tools as well as the set of services that comprise the [official NuGet Gallery](https://www.nuget.org). Combined, these form the NuGet project which is governed by the [.NET Foundation](https://www.dotnetfoundation.org/).
2121

2222
The NuGet Organization contains various repositories on GitHub. [https://github.com/Nuget/Home](https://github.com/Nuget/Home) gives an overview of all the repositories and where to find the various NuGet components.
2323

@@ -33,7 +33,7 @@ Many other individuals and companies have made significant contributions to the
3333
- [Artifactory](https://www.jfrog.com/artifactory/)
3434
- [BoxStarter](http://boxstarter.org/)
3535
- [Chocolatey](https://chocolatey.org/)
36-
- [CoApp](http://coapp.org/)
36+
- [CoApp](https://github.com/coapp/coapp.org)
3737
- [JetBrains ReSharper](https://resharper-plugins.jetbrains.com/)
3838
- [JetBrains Space](https://www.jetbrains.com/space/)
3939
- [JetBrains TeamCity](https://www.jetbrains.com/teamcity/)
@@ -56,20 +56,20 @@ Many other individuals and companies have made significant contributions to the
5656

5757
These are tools and utilities built on NuGet:
5858

59-
- [Glimpse Extensions](http://getglimpse.com/Packages) (plug-ins are packages)
59+
- [Glimpse Extensions](https://meetglimpse.com/)
6060
- [NuGetMustHaves.com](http://nugetmusthaves.com/)
6161
- [Orchard](http://www.orchardproject.net/) (CMS modules are fetched from a v1 NuGet feed hosted in the Orchard Gallery)
6262
- [Java implementation of NuGet Server](http://jonnyzzz.com/blog/2012/03/07/nuget-server-in-pure-java/)
6363
- [NuGetLatest](https://twitter.com/NuGetLatest) (Twitter bot tweeting new package publications)
64-
- [DefinitelyTyped](http://definitelytyped.org/) ([Automatic](https://github.com/DefinitelyTyped/NugetAutomation/) TypeScript Type [Definitions published to NuGet](http://www.nuget.org/packages?q=DefinitelyTyped))
64+
- [DefinitelyTyped](http://definitelytyped.org/) ([Automatic](https://github.com/DefinitelyTyped/NugetAutomation/) TypeScript Type [Definitions published to NuGet](https://www.nuget.org/packages?q=DefinitelyTyped))
6565

6666
## Training materials and references
6767

6868
Using a new tool or technology usually comes with a learning curve. Luckily for you, NuGet has no steep learning curve it all! In fact, anyone can [get started consuming packages](../quickstart/install-and-use-a-package-in-visual-studio.md) quickly.
6969

7070
That said, authoring packages–and especially good packages–along with embracing NuGet in automated build and deployment processes, requires spending a little more time with the following resources:
7171

72-
- [NuGet Blog](http://blog.nuget.org/)
72+
- [NuGet Blog](https://devblogs.microsoft.com/nuget/)
7373
- [NuGet team on Twitter, @nuget](http://twitter.com/nuget)
7474
- Books:
7575
- [Apress Pro NuGet](http://bit.ly/ProNuGet)

docs/reference/errors-and-warnings/NU3034.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
---
22
title: NuGet Error NU3034
33
description: NU3034 Error code
4-
author: patbel
5-
ms.author: patbel
4+
author: JonDouglas
5+
ms.author: jodou
66
ms.date: 11/12/2018
77
ms.topic: reference
88
ms.reviewer: rmpablos

docs/reference/errors-and-warnings/NU5048.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
title: NuGet Warning NU5048
33
description: NU5048 Warning code
44
author: dominoFire
5-
ms.author: feaguila
5+
ms.author: jodou
66
ms.date: 9/4/2019
77
ms.topic: reference
88
ms.reviewer: karann

docs/reference/nuget-config-file.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -115,7 +115,7 @@ Lists all known package sources. The order is ignored during restore operations
115115

116116
| Key | Value | protocolVersion |
117117
| --- | --- | --- |
118-
| (name to assign to the package source) | The path or URL of the package source. | The NuGet server protocol version to be used. The current version is "3". Defaults to version "2" when not pointing to a package source URL ending in `.json` (e.g. https://api.nuget.org/v3/index.json). Supported in [NuGet 3.0+](https://learn.microsoft.com/nuget/release-notes/nuget-3.0.0). See [NuGet Server API](https://learn.microsoft.com/nuget/api/overview) for more information about the version 3 protocol. |
118+
| (name to assign to the package source) | The path or URL of the package source. | The NuGet server protocol version to be used. The current version is "3". Defaults to version "2" when not pointing to a package source URL ending in `.json` (e.g. https://api.nuget.org/v3/index.json). Supported in [NuGet 3.0+](/nuget/release-notes/nuget-3.0.0). See [NuGet Server API](/nuget/api/overview) for more information about the version 3 protocol. |
119119

120120
**Example**:
121121

docs/release-notes/Known-Issues.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -164,7 +164,7 @@ If you try to uninstall NuGet via the Visual Studio Extension Manager, you may n
164164

165165
## The Package Manager Console crashes when I open it in Windows XP. What's wrong?
166166

167-
NuGet requires Powershell 2.0 runtime. Windows XP, by default, doesn't have Powershell 2.0. You can download the Powershell 2.0 runtime from <https://support.microsoft.com/kb/968929>. After you install it, restart Visual Studio and you should be able to open Package Manager Console.
167+
NuGet requires Powershell 2.0 runtime. Windows XP, by default, doesn't have Powershell 2.0. You can download the Powershell 2.0 runtime from [PowerShell 2.0 Download](https://devblogs.microsoft.com/powershell/tag/powershell-2-0-download/). After you install it, restart Visual Studio and you should be able to open Package Manager Console.
168168

169169
## Visual Studio 2010 SP1 Beta crashes on exit if the Package Manager Console is open.
170170

docs/release-notes/NuGet-3.5-Beta.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ ms.topic: conceptual
1111

1212
[NuGet 3.4 Release Notes](../release-notes/nuget-3.4.md) | [NuGet 3.5-Beta2 Release Notes](../release-notes/nuget-3.5-Beta2.md)
1313

14-
NuGet 3.5 Beta was released on May 16, 2016 as part of the ASP.NET Core Preview Tooling wave. This release adds support for .NET Core RC2 and ASP.NET Core RC2. For more information about this release please refer to [http://dot.net](http://dot.net).
14+
NuGet 3.5 Beta was released on May 16, 2016 as part of the ASP.NET Core Preview Tooling wave. This release adds support for .NET Core RC2 and ASP.NET Core RC2. For more information about this release please refer to [http://dot.net](https://dot.net).
1515

1616
You can download both the VSIX and nuget.exe [here](https://dist.nuget.org/index.html).
1717

0 commit comments

Comments
 (0)