-
Notifications
You must be signed in to change notification settings - Fork 4.8k
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
README for extensions libraries #77413
Conversation
Tagging subscribers to this area: @dotnet/area-meta Issue Detailsnull
|
Tagging subscribers to this area: @dotnet/area-extensions-logging Issue Detailsnull
|
ef2e369
to
609cc82
Compare
609cc82
to
cf659c1
Compare
src/libraries/Microsoft.Extensions.Caching.Abstractions/README.md
Outdated
Show resolved
Hide resolved
src/libraries/Microsoft.Extensions.Caching.Abstractions/README.md
Outdated
Show resolved
Hide resolved
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 added a couple of asks if you can consider it. LGTM otherwise. Thanks for getting this done!
src/libraries/Microsoft.Extensions.Caching.Abstractions/README.md
Outdated
Show resolved
Hide resolved
src/libraries/Microsoft.Extensions.Caching.Abstractions/README.md
Outdated
Show resolved
Hide resolved
src/libraries/Microsoft.Extensions.DependencyInjection/README.md
Outdated
Show resolved
Hide resolved
We might want to mention that these packages are part of the ASP.NET core shared framework in the deployment section. What's your thinking on readme's in all the related folders for these? Maybe those can link to the main readme for the area and also call out any interesting differences that might exist for those libraries (eg: if they are platform specific like SystemD or WindowsServices, etc) |
This is a good point and worth mentioning.
We are still adding more readme files to the extension libraries so we should cover all of them. I am hoping the readme be simple enough and not have many links for the user to jump around. kind of simple and inclusive as much as we can. |
What are the intended relationships between package readme and library readme discussed there? I'm asking because i were submitting readmes for Nuget packages before this initiative with library readmes (#59630), and they had different format with no "contribution bar" section. As a result, some libraries now have two different readmes, like for System.Text.Json: https://github.com/dotnet/runtime/tree/main/src/libraries/System.Text.Json and https://github.com/dotnet/runtime/tree/main/src/libraries/System.Text.Json/src. Is it planned to consolidate that somehow? If the library readme is reused for Nuget package, there's one possible issue, relative links to documents within repository will not work when readme is rendered on Nuget gallery. So the link to contribution bar description must be absolute. |
I prefer consolidating the library and the package readmes if possible.
Can we make those absolute links instead? |
Adds README for extensions libraries