Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add readmes to NuGet packages #6991

Closed
rainersigwald opened this issue Oct 25, 2021 · 0 comments · Fixed by #7291
Closed

Add readmes to NuGet packages #6991

rainersigwald opened this issue Oct 25, 2021 · 0 comments · Fixed by #7291
Assignees
@rainersigwald
Labels
Documentation Issues about docs, including errors and areas we should extend (this repo and learn.microsoft.com) packaging triaged
Milestone
VS 17.2

Comments

@rainersigwald
Copy link
Member

NuGet.org now prominently features READMEs. The NuGet packages MSBuild produces should use this to highlight a few things:

  1. Links to the docs.
  2. Which packages are the right ones to reference for task authors.
  3. Which packages are more or less "internal implementation details" (Runtime) and what you should use instead (MSBuildLocator).

After we get a draft out we should see if we can get some of @ghogen's time for editing.
@rainersigwald rainersigwald added packaging Documentation Issues about docs, including errors and areas we should extend (this repo and learn.microsoft.com) labels Oct 25, 2021
@rainersigwald rainersigwald added this to the MSBuild 17.1 milestone Oct 25, 2021
@marcpopMSFT marcpopMSFT modified the milestones: VS 17.1, VS 17.2 Jan 7, 2022
@rainersigwald rainersigwald self-assigned this Jan 13, 2022
@rainersigwald rainersigwald mentioned this issue Jan 13, 2022
Merged
@baronfel baronfel added merge-when-branch-open PRs that are approved, except that there is a problem that means we are not merging stuff right now. and removed merge-when-branch-open PRs that are approved, except that there is a problem that means we are not merging stuff right now. labels Jan 18, 2022
ladipro added a commit that referenced this issue Jan 25, 2022
@ladipro
Merge pull request #7291 from rainersigwald/nuget-readmes
750b4f2 
This should improve understandablity of our packages.

Fixes #6991.

Details on the format:

* https://docs.microsoft.com/nuget/nuget-org/package-readme-on-nuget-org
* https://devblogs.microsoft.com/nuget/add-a-readme-to-your-nuget-package/
@AR-May AR-May added the triaged label Feb 21, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@rainersigwald rainersigwald

Labels
Documentation Issues about docs, including errors and areas we should extend (this repo and learn.microsoft.com) packaging triaged
Projects
None yet
Milestone
VS 17.2
Development

Successfully merging a pull request may close this issue.

Add NuGet package READMEs rainersigwald/msbuild
4 participants
@baronfel @rainersigwald @marcpopMSFT @AR-May