From 4751bb1a5841dcd44880634a9bf6f9ae812e86b0 Mon Sep 17 00:00:00 2001
From: HonkingGoose <34918129+HonkingGoose@users.noreply.github.com>
Date: Sun, 29 Nov 2020 14:41:35 +0100
Subject: [PATCH] docs: improve NuGet documentation (#7826)
* use 1's for ordered list, fix whitespace
* use active voice
* fix typo: if -> in
* capitalize word Renovate
* rewrite sentences for clarity
* rewrite for clarity
* fix grammar
* use active voice
Co-authored-by: Rhys Arkins <rhys@arkins.net>
---
docs/usage/nuget.md | 18 +++++++++---------
1 file changed, 9 insertions(+), 9 deletions(-)
diff --git a/docs/usage/nuget.md b/docs/usage/nuget.md
index 0c08660c45..03c778d339 100644
--- a/docs/usage/nuget.md
+++ b/docs/usage/nuget.md
@@ -19,10 +19,10 @@ To convert your .NET Framework `.csproj`/`.fsproj`/`.vbproj` into an SDK-style p
## How It Works
-1. Renovate will search each repository for any files with a `.csproj`, `.fsproj`, or `.vbproj` extension
-2. Existing dependencies will be extracted from `<PackageReference>` and `<PackageVersion>` tags
-3. Renovate will look up the latest version on [nuget.org](https://nuget.org) (or on [alternate feeds](#Alternate%20feeds)) to determine if any upgrades are available
-4. If the source package includes a GitHub URL as its source, and has either a "changelog" file or uses GitHub releases, then Release Notes for each version will be embedded in the generated PR
+1. Renovate searches in each repository for any files with a `.csproj`, `.fsproj`, or `.vbproj` extension
+1. Existing dependencies are extracted from `<PackageReference>` and `<PackageVersion>` tags
+1. Renovate looks up the latest version on [nuget.org](https://nuget.org) (or on [alternate feeds](#Alternate%20feeds)) to determine if any upgrades are available
+1. If the source package includes a GitHub URL as its source, and has either a "changelog" file or uses GitHub releases, then Release Notes for each version are embedded in the generated PR
## Alternate feeds
@@ -39,15 +39,15 @@ Alternative feeds can be specified either [in a `NuGet.config` file](https://doc
}
```
-If this example we defined 3 NuGet feeds.
-Packages resolving will process feeds consequentially.
-It means that if package will be resolved in second feed renovate won't look in last one.
+In this example we defined 3 NuGet feeds.
+Package resolving processes feeds in the listed order, from top to bottom.
+This means that if a package is resolved in the second feed, Renovate won't check the third and final feed.
### Protocol versions
-NuGet supports two protocol versions, `v2` and `v3`, which NuGet client and server need to agree on.
+NuGet supports two protocol versions, `v2` and `v3`, the NuGet client and server must use the same protocol version.
Renovate as a NuGet client supports both versions and will use `v2` unless the configured feed URL ends with `index.json` (which mirrors the behavior of the official NuGet client).
-If you have `v3` feed that does not match this pattern (e.g. JFrog Artifactory) you need to help Renovate by appending `#protocolVersion=3` to the registry URL:
+If you have a `v3` feed that does not match this pattern (e.g. JFrog Artifactory) you need to help Renovate by appending `#protocolVersion=3` to the registry URL:
```json
"nuget": {
--
GitLab