Update PM UI README rendering spec #14001
Conversation
| @@ -22,15 +22,29 @@ The PM UI will be updated to have tabs for the Package Details and the the READM | |||
| The README will be available in all the PM UI tabs. | |||
| It will also be displayed for both the solution level and project level package managers. | |||
|
|
|||
| The selected tab will be maintained between sessions and when switching packages. | |||
There was a problem hiding this comment.
Is this implemented already or is a PR coming?
There was a problem hiding this comment.
Does any of this consider whether the source supports readmes?
There was a problem hiding this comment.
Is this implemented already or is a PR coming?
Already implemented, just clarifying that even if the selected package does not have a README we will stay on the tab.
There was a problem hiding this comment.
Does any of this consider whether the source supports readmes?
The start of the section says "This tab is rendered if a remote source available to download the readme or the Installed tab is selected and the selected version is found in the global packages folder." I feel like that covered it.
| @@ -22,15 +22,29 @@ The PM UI will be updated to have tabs for the Package Details and the the READM | |||
| The README will be available in all the PM UI tabs. | |||
| It will also be displayed for both the solution level and project level package managers. | |||
|
|
|||
| The selected tab will be maintained between sessions and when switching packages. | |||
| If the README tab is removed, then the "Package Details" tab will automatically selected. | |||
There was a problem hiding this comment.
This isn't a change from what's already shipped, right?
There was a problem hiding this comment.
What does remove mean in this case?
How do you remove the tab?
There was a problem hiding this comment.
This isn't a change from what's already shipped, right?
Correct, just describing what's already implemented.
What does remove mean in this case? How do you remove the tab?
I updated the language to say "available". The availability of the tab is described in the README Tab section.
| If the README tab is rendered and we do not find a README then a message is rendered encouraging the user to contact the package author to upload a README. | ||
|  | ||
| When there is no README available we will display a message to the user in the README tab. | ||
| >There is no README available for the selected package version. For me information please visit [aka.ms/nuget/noreadme](https://aka.ms/nuget/noreadme). |
There was a problem hiding this comment.
LGTM. Assuming the aka.ms link will be linked to its own page in the future
There was a problem hiding this comment.
yup! @OliaG is working on adding a section to the NuGet FAQs
| @@ -22,15 +22,29 @@ The PM UI will be updated to have tabs for the Package Details and the the READM | |||
| The README will be available in all the PM UI tabs. | |||
| It will also be displayed for both the solution level and project level package managers. | |||
|
|
|||
| The selected tab will be maintained between sessions and when switching packages. | |||
| If the README tab is removed, then the "Package Details" tab will automatically selected. | |||
There was a problem hiding this comment.
What does remove mean in this case?
How do you remove the tab?
| @@ -22,15 +22,20 @@ The PM UI will be updated to have tabs for the Package Details and the the READM | |||
| The README will be available in all the PM UI tabs. | |||
| It will also be displayed for both the solution level and project level package managers. | |||
|
|
|||
There was a problem hiding this comment.
What about which tab we default to?
There was a problem hiding this comment.
I added a line about that.
| @@ -22,15 +22,29 @@ The PM UI will be updated to have tabs for the Package Details and the the READM | |||
| The README will be available in all the PM UI tabs. | |||
| It will also be displayed for both the solution level and project level package managers. | |||
|
|
|||
| The selected tab will be maintained between sessions and when switching packages. | |||
There was a problem hiding this comment.
Does any of this consider whether the source supports readmes?
Update to specify new message and tab selection behavior.