Skip to content

Commit a40c1c1

Browse files
author
Kraig Brockschmidt
authored
Merge pull request NuGet#636 from NuGet/master
Publish to live
2 parents 1ebfff1 + 3211f03 commit a40c1c1

File tree

62 files changed

+183
-170
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

62 files changed

+183
-170
lines changed

.openpublishing.redirection.json

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
{
2+
"redirections": [
3+
{
4+
"source_path": "docs/API/introduction.md",
5+
"redirect_url": "/nuget/api/overview",
6+
"redirect_document_id": false
7+
},
8+
{
9+
"source_path": "docs/API/NuGet-API-V3.md",
10+
"redirect_url": "/nuget/reference/nuget-client-sdk",
11+
"redirect_document_id": false
12+
},
13+
{
14+
"source_path": "docs/API/NuGet-Credential-Providers-for-Visual-Studio.md",
15+
"redirect_url": "/nuget/reference/extensibility/nuget-credential-providers-for-visual-studio",
16+
"redirect_document_id": false
17+
},
18+
{
19+
"source_path": "docs/API/nuget-exe-Credential-Providers.md",
20+
"redirect_url": "/nuget/reference/extensibility/nuget-exe-credential-providers",
21+
"redirect_document_id": false
22+
},
23+
{
24+
"source_path": "docs/Create-Packages/Dependency-Versions.md",
25+
"redirect_url": "/nuget/reference/package-versioning",
26+
"redirect_document_id": false
27+
},
28+
{
29+
"source_path": "docs/Quickstart/restore.md",
30+
"redirect_url": "/nuget/consume-packages/package-restore-troubleshooting",
31+
"redirect_document_id": false
32+
}
33+
]
34+
}

README.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -17,11 +17,11 @@ NuGet follows the [.NET Foundation Contributors Code of Conduct](https://github.
1717

1818
No contribution is too big or too small--
1919

20-
1. Visit the page to edit on [docs.microsoft.com/nuget](https://docs.microsoft.com/en-us/nuget/), then click the **Edit** button on the top right. This brings you to the appropriate markdown page in the repo.
20+
1. Visit the page to edit on [docs.microsoft.com/nuget](/en-us/nuget/), then click the **Edit** button on the top right. This brings you to the appropriate markdown page in the repo.
2121
1. Edit the markdown:
2222
1. If you're including images (use PNGs, generally), place them in the media folder that's in the topic's folder. Links are then `media/<image_name>.png`.
2323
1. Relative links to other pages in this docset should be in the form `../<folder>/<topic-file>.md` including the training `.md`. If you're linking to another topic in the same folder, then `../<folder>/` can be omitted. When using anchors, always remember to include the `.md` before the `#`.
24-
1. When using external links, especially to docs.microsoft.com or msdn.microsoft.com, omit any language tag like "en-us" so that a reader in another language lands on a target page in that same language if it's available.
24+
1. When using external links, especially to docs.microsoft.com (or msdn.microsoft.com for any older content), omit any language tag like "en-us" so that a reader in another language lands on a target page in that same language if it's available.
2525
1. When you're done, enter a commit message below, and click **Propose file change**.
2626
1. Send a pull request for your change. We review PRs on a regular basis.
2727
1. Thank you!
@@ -121,16 +121,16 @@ The only case when you should use ``` without a language tag is when creating a
121121

122122
docs.microsoft.com uses blockquotes for callouts, that is, lines starting with ">".
123123

124-
Callout sections with ">" only will appear with a solid gray line to the left. See [Creating NuGet packages](https://docs.microsoft.com/en-us/nuget/create-packages/creating-a-package) for examples.
124+
Callout sections with ">" only will appear with a solid gray line to the left. See [Creating NuGet packages](/en-us/nuget/create-packages/creating-a-package) for examples.
125125

126126
You can also use one of the following callout tags on the first line that will create a shaded callout in the indicated color:
127127

128128
| Tag | Shading color | Topic with examples |
129129
| --- | --- | --- |
130-
| `> [!Note]` | Light blue, use for callouts without any special emphasis. | [Creating NuGet packages](https://docs.microsoft.com/nuget/create-packages/creating-a-package) |
131-
| `> [!Tip]` | Green, use for callouts that share special tips and tricks or other helpful knowledge. | [Package consumption overview](https://docs.microsoft.com/nuget/consume-packages/overview-and-workflow) |
132-
| `> [!Important]` | Yellow, use for callouts that describe cautions. | [NuGet.Server](https://docs.microsoft.com/nuget/hosting-packages/nuget-server) |
133-
| `> [!Warning]` | Red, use for callouts that warn readers about situations that could cause data loss or unexpected consequences. | [Dependency resolution](https://docs.microsoft.com/nuget/consume-packages/dependency-resolution) |
130+
| `> [!Note]` | Light blue, use for callouts without any special emphasis. | [Creating NuGet packages](/nuget/create-packages/creating-a-package) |
131+
| `> [!Tip]` | Green, use for callouts that share special tips and tricks or other helpful knowledge. | [Package consumption overview](/nuget/consume-packages/overview-and-workflow) |
132+
| `> [!Important]` | Yellow, use for callouts that describe cautions. | [NuGet.Server](/nuget/hosting-packages/nuget-server) |
133+
| `> [!Warning]` | Red, use for callouts that warn readers about situations that could cause data loss or unexpected consequences. | [Dependency resolution](/nuget/consume-packages/dependency-resolution) |
134134

135135
### Links
136136

@@ -139,7 +139,7 @@ You can also use one of the following callout tags on the first line that will c
139139
- Links to other markdown files on docs.microsoft.com are case-insensitive (unlike links to files in GitHub, which are).
140140
- If you're linking to another topic in the same folder, then `../<folder>/` can be omitted.
141141
- When using anchors, always remember to include the `.md` before the `#`.
142-
- When using external links, especially to docs.microsoft.com or msdn.microsoft.com, omit any language tag like "en-us" so that a reader in another language lands on a target page in that same language if it's available.
142+
- When using external links, especially to docs.microsoft.com (or msdn.microsoft.com for any older content), omit any language tag like "en-us" so that a reader in another language lands on a target page in that same language if it's available.
143143
- Bare URLs are not automatically converted into links.
144144

145145
### Inline HTML

docs/API/NuGet-API-V3.md

Lines changed: 0 additions & 3 deletions
This file was deleted.

docs/API/NuGet-Credential-Providers-for-Visual-Studio.md

Lines changed: 0 additions & 3 deletions
This file was deleted.

docs/API/NuGet-Protocols.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -52,8 +52,8 @@ Clients are required to pass the following header when they make API calls to **
5252
X-NuGet-Protocol-Version: 4.1.0
5353
```
5454

55-
Note that the pre-existing `X-NuGet-Client-Version` header has the same purpose but is now deprecated and should no
56-
longer be used.
55+
Note that the `X-NuGet-Client-Version` header has similar semantics but is reserved to only be used by the official
56+
NuGet client. Third party clients should use the `X-NuGet-Protocol-Version` header and value.
5757

5858
The **push** protocol itself is described in the documentation for the
5959
[`PackagePublish` resource](package-publish-resource.md).

docs/API/catalog-resource.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -266,7 +266,7 @@ requireLicenseAgreement | boolean | no | Assume `false`
266266
summary | string | no |
267267
tags | array of strings | no |
268268
title | string | no |
269-
verbatimVersion | string | no | The version string as it is originally found in the .nuspec
269+
verbatimVersion | string | no | The version string as it's originally found in the .nuspec
270270

271271
The package `version` property is the full, normalized version string. This means that SemVer 2.0.0 build data can
272272
be included here.

docs/API/introduction.md

Lines changed: 0 additions & 3 deletions
This file was deleted.

docs/API/nuget-exe-Credential-Providers.md

Lines changed: 0 additions & 3 deletions
This file was deleted.

docs/API/overview.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ The NuGet API is a set of HTTP endpoints that can be used to download packages,
3131
and perform most other operations available in the official NuGet clients.
3232

3333
This API is used by the NuGet client in Visual Studio, nuget.exe, and the .NET CLI to perform NuGet operations such as
34-
[`dotnet restore`](https://docs.microsoft.com/dotnet/articles/core/preview3/tools/dotnet-restore), search in the Visual
34+
[`dotnet restore`](/dotnet/articles/core/preview3/tools/dotnet-restore), search in the Visual
3535
Studio UI, and [`nuget.exe push`](../tools/cli-ref-push.md).
3636

3737
Note in some cases, nuget.org has additional requirements that are not enforced by other package sources. These
@@ -62,7 +62,7 @@ version string's minor version will be increased.
6262
Older clients (such as nuget.exe 2.x) do not support the V3 API and only support the older V2 API, which is not
6363
documented here.
6464

65-
The NuGet V3 API is named as such because it is the successor of the V2 API, which was the OData-based protocol
65+
The NuGet V3 API is named as such because it's the successor of the V2 API, which was the OData-based protocol
6666
implemented by the 2.x version of the official NuGet client. The V3 API was first supported by the 3.0 version of the
6767
official NuGet client and is still the latest major protocol version supported by the NuGet client, 4.0 and on.
6868

docs/API/package-base-address-resource.md

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -71,8 +71,7 @@ Name | In | Type | Required | Notes
7171
LOWER_ID | URL | string | yes | The package ID, lowercase
7272

7373
The `LOWER_ID` value is the desired package ID lowercased using the rules implemented by .NET's
74-
[`System.String.ToLowerInvariant()`](https://msdn.microsoft.com/en-us/library/system.string.tolowerinvariant.aspx)
75-
method.
74+
[`System.String.ToLowerInvariant()`](/dotnet/api/system.string.tolowerinvariant?view=netstandard-2.0#System_String_ToLowerInvariant) method.
7675

7776
### Response
7877

@@ -119,7 +118,7 @@ LOWER_ID | URL | string | yes | The package ID, lowercase
119118
LOWER_VERSION | URL | string | yes | The package version, normalized and lowercased
120119

121120
Both `LOWER_ID` and `LOWER_VERSION` are lowercased using the rules implemented by .NET's
122-
[`System.String.ToLowerInvariant()`](https://msdn.microsoft.com/en-us/library/system.string.tolowerinvariant.aspx)
121+
[`System.String.ToLowerInvariant()`](/dotnet/api/system.string.tolowerinvariant?view=netstandard-2.0#System_String_ToLowerInvariant)
123122
method.
124123

125124
The `LOWER_VERSION` is the desired package version normalized using NuGet's version
@@ -160,8 +159,7 @@ LOWER_ID | URL | string | yes | The package ID, lowercase
160159
LOWER_VERSION | URL | integer | yes | The package version, normalized and lowercased
161160

162161
Both `LOWER_ID` and `LOWER_VERSION` are lowercased using the rules implemented by .NET's
163-
[`System.String.ToLowerInvariant()`](https://msdn.microsoft.com/en-us/library/system.string.tolowerinvariant.aspx)
164-
method.
162+
[`System.String.ToLowerInvariant()`](/dotnet/api/system.string.tolowerinvariant?view=netstandard-2.0#System_String_ToLowerInvariant) method.
165163

166164
The `LOWER_VERSION` is the desired package version normalized using NuGet's version
167165
[normalization rules](../reference/package-versioning.md#normalized-version-numbers). This means that build metadata

0 commit comments

Comments
 (0)