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

Display documentations in show command #2212

Merged
merged 4 commits into from
Jun 2, 2022

Conversation

ryfu-msft
Copy link
Contributor

@ryfu-msft ryfu-msft commented Jun 1, 2022

Resolves: #1984

  • Adds support for displaying the documentation label and url provided in the manifest when invoking the show command
Microsoft Reviewers: Open in CodeFlow

@ryfu-msft ryfu-msft requested a review from a team as a code owner June 1, 2022 21:40
@ghost ghost added Area-Manifest This may require a change to the manifest Issue-Feature This is a feature request for the Windows Package Manager client. labels Jun 1, 2022
Copy link
Member

@JohnMcPMS JohnMcPMS left a comment

Choose a reason for hiding this comment

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

Should we consider showing these in the event of an install/upgrade failure where we don't have an expected return code URL to show? @denelon again for consideration.

src/AppInstallerCLICore/Workflows/ShowFlow.cpp Outdated Show resolved Hide resolved
@ghost ghost added the Needs-Author-Feedback Issue needs attention from issue or PR author label Jun 1, 2022
@denelon
Copy link
Contributor

denelon commented Jun 1, 2022

Should we consider showing these in the event of an install/upgrade failure where we don't have an expected return code URL to show? @denelon Demitrius Nelon FTE again for consideration.

My thoughts are showing the return code in either case, and optionally the URL when one is present. If there isn't a URL there isn't much we can do.

@ryfu-msft
Copy link
Contributor Author

Should we consider showing these in the event of an install/upgrade failure where we don't have an expected return code URL to show? @denelon Demitrius Nelon FTE again for consideration.

My thoughts are showing the return code in either case, and optionally the URL when one is present. If there isn't a URL there isn't much we can do.

I don't think we should be showing the documentations after a failed install/upgrade as it seems like documentations could refer to anything and might not be related to the actual install/upgrade failure. I would think it would make more sense to optionally show the documentationUrls only after a successful install/upgrades as that would allow the user to immediately get the information needed to get started with the newly-installed package.

@ghost ghost removed the Needs-Author-Feedback Issue needs attention from issue or PR author label Jun 1, 2022
@ryfu-msft ryfu-msft requested a review from JohnMcPMS June 2, 2022 00:27
@denelon
Copy link
Contributor

denelon commented Jun 2, 2022

@ryfu-msft I misunderstood the ask. If it's just a "generic" documentation link, then no, we shouldn't show that URL if the install/upgrade failed. I thought we were referencing the URL associated with the expected return code.

@ryfu-msft ryfu-msft merged commit babc5a4 into microsoft:master Jun 2, 2022
@ryfu-msft ryfu-msft deleted the userDocumentation branch June 2, 2022 23:13
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Area-Manifest This may require a change to the manifest Issue-Feature This is a feature request for the Windows Package Manager client.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Manifest Field for User Manual / Documentation
4 participants