dotnet / dotnet/docfx

[Feature Request] Deprecate NuGet packages that are no longer published

Open
#8,932 6 comments 2 reactions 0 assignees View on GitHub
fundamental
Dominant language
C#
Stars
4.4k
Forks
890
Avg merge
2h 11m
Merged PRs (30d)
10

Description

**Is your feature request related to a problem? Please describe.**

Many NuGet packages were built from earlier versions of DocFX and are no longer being updated, but they remain in the NuGet Gallery. Users can be mislead into referencing the unmaintained packages.

**Describe the solution you'd like**

Mark the packages as deprecated in NuGet Gallery. [Deprecating packages on nuget.org](https://learn.microsoft.com/en-us/nuget/nuget-org/deprecate-packages)

**Describe alternatives you've considered**

Publish new versions of these packages, just to update the README so it says these should not be used.

**Additional context**

All versions of the following packages should be deprecated. I list the latest version of each package, to show that these packages were not published as part of DocFX 2.67.5.

- [ ] [msdn.4.5.2](https://www.nuget.org/packages/msdn.4.5.2) 0.1.0-alpha-1611021200:\
Removed in .\
The newest version 0.1.0-alpha-1611021200 has been deprecated, but earlier versions have not.
- [x] [AzureMarkdownRewriterTool](https://www.nuget.org/packages/AzureMarkdownRewriterTool) 2.42.3:\
Removed in .\
Advice: Public DocFX packages no longer support building Microsoft Learn content. See for recommended tools.
- [x] [Microsoft.DocAsCode.AzureMarkdownRewriters](https://www.nuget.org/packages/Microsoft.DocAsCode.AzureMarkdownRewriters) 2.42.3:\
Removed in .\
Advice: Public DocFX packages no longer support building Microsoft Learn content. See for recommended tools.
- [ ] [DfmHttpService](https://www.nuget.org/packages/DfmHttpService) 2.43.0:\
Removed in .\
The newest version 2.43.0 has been deprecated, but earlier versions have not.
- [x] [docfx.console](https://www.nuget.org/packages/docfx.console) 2.59.4:\
Removed in .\
Advice: Use the `docfx` .NET tool package instead.
- [ ] [MarkdownMigrateTool](https://www.nuget.org/packages/MarkdownMigrateTool) 2.59.4:\
Removed in .\
The newest version 2.59.4 has been deprecated, but earlier versions have not.
- [ ] [memberpage](https://www.nuget.org/packages/memberpage) 2.59.4:\
Removed in .\
The newest version 2.59.4 has been deprecated, but earlier versions have not.\
Advice: Set `"memberLayout": "separatePages"` in the configuration of the `metadata` command, instead.
- [ ] [memberpage.plugins](https://www.nuget.org/packages/memberpage.plugins) 2.59.4:\
Removed in .\
The newest version 2.59.4 has been deprecated, but earlier versions have not.\
Advice: Set `"memberLayout": "separatePages"` in the configuration of the `metadata` command, instead.
- [ ] [MergeDeveloperComments](https://www.nuget.org/packages/MergeDeveloperComments) 2.59.4:\
Removed in .\
The newest version 2.59.4 has been deprecated, but earlier versions have not.
- [ ] [MergeSourceInfo](https://www.nuget.org/packages/MergeSourceInfo) 2.59.4:\
Removed in .\
The newest version 2.59.4 has been deprecated, but earlier versions have not.
- [ ] [rest.operationpage](https://www.nuget.org/packages/rest.operationpage) 2.59.4:\
Removed in .\
The newest version 2.59.4 has been deprecated, but earlier versions have not.\
Advice: Build your own executable that references the `Microsoft.DocAsCode.App` and `Microsoft.DocAsCode.Build.OperationLevelRestApi` packages.
- [ ] [rest.tagpage](https://www.nuget.org/packages/rest.tagpage) 2.59.4:\
Removed in .\
The newest version 2.59.4 has been deprecated, but earlier versions have not.\
Advice: Build your own executable that references the `Microsoft.DocAsCode.App` and `Microsoft.DocAsCode.Build.TagLevelRestApi` packages.
- [ ] [SandcastleRefMapper](https://www.nuget.org/packages/SandcastleRefMapper) 2.59.4:\
Removed in .\
The newest version 2.59.4 has been deprecated, but earlier versions have not.
- [ ] [TocConverter](https://www.nuget.org/packages/TocConverter) 2.59.4:\
Removed in .\
The newest version 2.59.4 has been deprecated, but earlier versions have not.
- [ ] [YamlSplitter](https://www.nuget.org/packages/YamlSplitter) 2.59.4:\
Removed in .\
The newest version 2.59.4 has been deprecated, but earlier versions have not.
- [x] [Microsoft.DocAsCode.Metadata.ManagedReference.FSharp](https://www.nuget.org/packages/Microsoft.DocAsCode.Metadata.ManagedReference.FSharp) 2.60.2:\
Removed in .\
Native F# support was discontinued. See also .
- [x] [Microsoft.DocAsCode.MarkdigMarkdownRewriters](https://www.nuget.org/packages/Microsoft.DocAsCode.MarkdigMarkdownRewriters) 2.60.2:\
Removed in .
- [x] [Microsoft.DocAsCode.DataContracts.ManagedReference](https://www.nuget.org/packages/Microsoft.DocAsCode.DataContracts.ManagedReference) 2.61.0:\
Consolidated in .\
Advice: Use the `Microsoft.DocAsCode.Dotnet` package instead.
- [x] [Microsoft.DocAsCode.Metadata.ManagedReference](https://www.nuget.org/packages/Microsoft.DocAsCode.Metadata.ManagedReference) 2.61.0:\
Consolidated in .\
Advice: Use the `Microsoft.DocAsCode.Dotnet` package instead.
- [x] [Microsoft.DocAsCode.Build.MergeOverwrite](https://www.nuget.org/packages/Microsoft.DocAsCode.Build.MergeOverwrite) 2.61.0:\
Removed in .
- [x] [Microsoft.DocAsCode.Metadata.ManagedReference.Roslyn](https://www.nuget.org/packages/Microsoft.DocAsCode.Metadata.ManagedReference.Roslyn) 2.61.0:\
Consolidated in .\
Advice: Use the `Microsoft.DocAsCode.Dotnet` package instead.
- [x] [Microsoft.DocAsCode.Metadata.ManagedReference.Common](https://www.nuget.org/packages/Microsoft.DocAsCode.Metadata.ManagedReference.Common) 2.61.0:\
Consolidated in .\
Advice: Use the `Microsoft.DocAsCode.Dotnet` package instead.
- [x] [Microsoft.DocAsCode.MarkdownLite](https://www.nuget.org/packages/Microsoft.DocAsCode.MarkdownLite) 2.63.1:\
Removed in .\
Advice: The DocFX Flavored Markdown (DFM) engine is no longer supported. Use Markdig instead.
- [x] [Microsoft.DocAsCode.Dfm](https://www.nuget.org/packages/Microsoft.DocAsCode.Dfm) 2.63.1:\
Removed in .\
Advice: The DocFX Flavored Markdown (DFM) engine is no longer supported. Use Markdig instead.
- [x] [Microsoft.DocAsCode.Build.MemberLevelManagedReference](https://www.nuget.org/packages/Microsoft.DocAsCode.Build.MemberLevelManagedReference) 2.63.1:\
Removed in .\
Advice: Set `"memberLayout": "separatePages"` in the configuration of the `metadata` command, instead.

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.