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

Document the Package Source Mappings workflow in VS Options & PM UI #3079

Merged
merged 4 commits into from Jun 20, 2023

Conversation

donnie-msft
Copy link
Contributor

@donnie-msft donnie-msft commented Jun 20, 2023

Fixes: #3063
Fixes: #2799

@donnie-msft donnie-msft requested review from a team as code owners June 20, 2023 15:54
@learn-build-service-prod
Copy link

Learn Build status updates of commit dcb3d74:

⚠️ Validation status: warnings

File Status Preview URL Details
docs/consume-packages/Package-Source-Mapping.md ⚠️Warning View Details
docs/consume-packages/media/packageSourceMapping_PMUI_Status_Mapped.png ✅Succeeded View
docs/consume-packages/media/packageSourceMapping_PMUI_Status_Off_Annotated.png ✅Succeeded View
docs/consume-packages/media/packageSourceMapping_VSOptions_AddMappingCompleted.png ✅Succeeded View
docs/consume-packages/media/packageSourceMapping_VSOptions_AddMappingFilled.png ✅Succeeded View
docs/consume-packages/media/packageSourceMapping_VSOptions_AddMappingOpened.png ✅Succeeded View
docs/consume-packages/media/packageSourceMapping_VSOptions_NoMappings.png ✅Succeeded View

docs/consume-packages/Package-Source-Mapping.md

  • Line 72, Column 1: [Warning: file-not-found - See documentation] Invalid file link: 'media/packageSourceMapping_VSOptions_AddMappingComplete.png'.

For more details, please refer to the build report.

Note: Your PR may contain errors or warnings or suggestions unrelated to the files you changed. This happens when external dependencies like GitHub alias, Microsoft alias, cross repo links are updated. Please use these instructions to resolve them.

For any questions, please:


![The NuGet Package Manager window in Visual Studio showing a selected package, and a highlight around the "Package source mapping is off" status with a `Configure` button.](media/packageSourceMapping_PMUI_Status_Off_Annotated.png)

_From the Visual Studio Options Dialog_
Copy link
Contributor

Choose a reason for hiding this comment

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

This seems a bit confusing. Should we show this selection of Tools? Or could someone just open generic VS Options too?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Yes, my point was that you can either use Tools menu or you can use PM UI with the Configure shortcut.
I can show it... but I thought selecting Tools was convered in another docs.

|-----|---------------------|---------------------|---------------------|
| 17.0 - 17.4 | ✅ Available | ❌ Not available | ❌ Not available |
| 17.5 | ✅ Available | ✅ Available | ❌ Not available |
| 17.7 Preview 3| ✅ Available | ✅ Available | ✅ Status displayed |
Copy link
Contributor

Choose a reason for hiding this comment

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

Great table, but I think we should simplify with a note to be consistent with all other docs. See https://learn.microsoft.com/en-us/nuget/consume-packages/central-package-management#global-package-references for an example

Fine to keep it for now too

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Chatted offline - may reduce the table into a couple notes once more features have shipped

Copy link
Contributor

@JonDouglas JonDouglas left a comment

Choose a reason for hiding this comment

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

Great docs additions! Added some comments for consideration.

@donnie-msft donnie-msft merged commit aa23265 into main Jun 20, 2023
2 checks passed
@donnie-msft donnie-msft deleted the dev-donnie-msft-psmDocs branch June 20, 2023 22:36
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
2 participants