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.

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

Update about-the-dependency-graph.md #17112

Merged
merged 3 commits into from
Apr 20, 2022
Merged

Conversation

rukasakurai
Copy link
Contributor

@rukasakurai rukasakurai commented Apr 15, 2022

  • NuGet is the package manager for .NET
  • C++ is not a .NET language

Why:

Inaccurate information on "About the dependency graph" page "Supported package ecosystems" section

Closes #17111

What's being changed:

  • Package manager for .NET to NuGet
  • Removing C++ from the list of .NET languages

- NuGet is the package manager for .NET
- C++ is not a .NET language
@welcome
Copy link

welcome bot commented Apr 15, 2022

Thanks for opening this pull request! A GitHub docs team member should be by to give feedback soon. In the meantime, please check out the contributing guidelines.

@github-actions github-actions bot added the triage Do not begin working on this issue until triaged by the team label Apr 15, 2022
@github-actions
Copy link
Contributor

github-actions bot commented Apr 15, 2022

Automatically generated comment ℹ️

This comment is automatically generated and will be overwritten every time changes are committed to this branch.

The table contains an overview of files in the content directory that have been changed in this pull request. It's provided to make it easy to review your changes on the staging site. Please note that changes to the data directory will not show up in this table.


Content directory changes

You may find it useful to copy this table into the pull request summary. There you can edit it to share links to important articles or changes and to give a high-level overview of how the changes in your pull request support the overall goals of the pull request.

Source Preview Production What Changed
content/code-security/supply-chain-security/understanding-your-software-supply-chain/about-the-dependency-graph.md Modified Original

@ramyaparimi ramyaparimi added content This issue or pull request belongs to the Docs Content team waiting for review Issue/PR is waiting for a writer's review code security Content related to code security and removed triage Do not begin working on this issue until triaged by the team labels Apr 15, 2022
@ramyaparimi
Copy link
Contributor

@rukasakurai
Thanks so much for opening a PR! I'll get this triaged for review ⚡

Copy link
Contributor

@SMAKSS SMAKSS left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I guess NuGet is only one of the options and we also do have .NET CLI for managing all the .NET application tools.

@lecoursen lecoursen added the needs SME This proposal needs review from a subject matter expert label Apr 18, 2022
@github-actions
Copy link
Contributor

Thanks for opening a pull request! We've triaged this issue for technical review by a subject matter expert 👀

@SIkebe
Copy link
Contributor

SIkebe commented Apr 18, 2022

Hi @rukasakurai , I raised a similar PR (#17110) a few hours before this one 😄
I'm not very familiar with C++, but NuGet supports C++ according to some docs.

What programming languages are supported by NuGet?
NuGet generally works for .NET languages and is designed to bring .NET libraries into a project. Because it also supports MSBuild and Visual Studio automation in some project types, it also supports other projects and languages to various degrees.

The most recent version of NuGet supports C#, Visual Basic, F#, WiX, and C++.

https://docs.microsoft.com/en-us/nuget/resources/nuget-faq#what-programming-languages-are-supported-by-nuget-

NuGet for C++
https://devblogs.microsoft.com/cppblog/nuget-for-c/

@SIkebe
Copy link
Contributor

SIkebe commented Apr 18, 2022

I guess NuGet is only one of the options and we also do have .NET CLI for managing all the .NET application tools.

"NuGet" is the package manager. the NuGet client in Visual Studio, nuget.exe, and .NET CLI all implements NuGet Server API to do operations related to NuGet.
So "NuGet" is suitable here for package manager name.

@@ -66,7 +66,7 @@ The recommended formats explicitly define which versions are used for all direct
| Package manager | Languages | Recommended formats | All supported formats |
| --- | --- | --- | ---|
| Composer | PHP | `composer.lock` | `composer.json`, `composer.lock` |
| `dotnet` CLI | .NET languages (C#, C++, F#, VB) | `.csproj`, `.vbproj`, `.nuspec`, `.vcxproj`, `.fsproj` | `.csproj`, `.vbproj`, `.nuspec`, `.vcxproj`, `.fsproj`, `packages.config` |
| NuGet | .NET languages (C#, F#, VB) | `.csproj`, `.vbproj`, `.nuspec`, `.vcxproj`, `.fsproj` | `.csproj`, `.vbproj`, `.nuspec`, `.vcxproj`, `.fsproj`, `packages.config` |
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is there any reason why you removed C++ and kept .vcxproj?

Copy link
Contributor Author

@rukasakurai rukasakurai Apr 19, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for noticing. I've added C++ back into the list of Langauges that NuGet supports, but outside of the () for .NET Languages, in which case there's no need to delete .vcxproj

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

but outside of the () for .NET Languages

Yeah, that should be fine👍 Thanks!

@felicitymay
Copy link
Contributor

@rukasakurai and @SIkebe - many thanks for raising this problem with the docs ✨ and for your constructive discussion in this pull request 💖

We're checking on the reasons for the original content and will get back to you as soon as we can.

@annarosenthal
Copy link
Contributor

Hi all, I'm an engineer on the Dependency Graph team and I can confirm that these proposed changes are accurate. Thank you for the update and links to support the update, @rukasakurai @SIkebe.

@ramyaparimi ramyaparimi added SME reviewed An SME has reviewed this issue/PR and removed needs SME This proposal needs review from a subject matter expert labels Apr 20, 2022
Copy link
Contributor

@felicitymay felicitymay left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Many thanks for confirming that this is a good change @annarosenthal 💖

We'll merge this PR 🚀

@felicitymay felicitymay enabled auto-merge (squash) April 20, 2022 15:26
@felicitymay felicitymay merged commit 25017a9 into github:main Apr 20, 2022
@github-actions
Copy link
Contributor

Thanks very much for contributing! Your pull request has been merged 🎉 You should see your changes appear on the site in approximately 24 hours. If you're looking for your next contribution, check out our help wanted issues

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
code security Content related to code security content This issue or pull request belongs to the Docs Content team SME reviewed An SME has reviewed this issue/PR waiting for review Issue/PR is waiting for a writer's review
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Inaccurate information on "About the dependency graph" page "Supported package ecosystems" section
7 participants