-
Notifications
You must be signed in to change notification settings - Fork 253
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
Add Tech Spec for rendering README in PM UI #13200
base: dev
Are you sure you want to change the base?
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks good! Left a few suggestions.
Looks good left a few comments to help |
Co-authored-by: Nigusu Solomon Yenework <[email protected]>
…Get/Home into dev-jgonz-pmuiReadmeRendering
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Great progress - there's a lot of cool stuff coming with this work!
btw, I'd probably edit the title of the PR to mention README.
Review Meeting: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM 👏
A couple of experience questions about the details and readme tabs.
Can we update the title of this PR to something more representative? |
... | ||
} | ||
``` | ||
##### PackageBaseAddress/6.12.0 | ||
|
||
A new version of the [package content](https://learn.microsoft.com/en-us/nuget/api/package-base-address-resource) resource type which will include a url definition for downloading the README. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pedantic: This example below is not showing the URL to download the readme, it's showing a base URL, for which a URL has to be generated. It also doesn't tell us what the generated URL will be. See the docs for examples how they explain to both service and client implementors what the expected URL will be.
Guessing from the registration example's rawReadMeUrl, I assume the proposed filename will be readme
. Consider the two documented resources both have file extensions, and embedded readmes only support markdown, should it be readme.md
?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I can update the doc, as for the URI. Users can pick whatever name they want for the README. If we set the api {@id}/{LOWER_ID}/{LOWER_VERSION}/readme.md it implies like are specifically looking for that file. As opposed to /readme which leaves it open to whatever readme is available for that package.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
yes, the doc needs to explain how server implementors tell client what filename to use (what pattern client will use to generate the URl that will be requested)
Tech spec for #12583