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

README for extensions libraries #77413

Merged
merged 2 commits into from
Oct 25, 2022
Merged

Conversation

maryamariyan
Copy link
Member

@maryamariyan maryamariyan commented Oct 24, 2022

Adds README for extensions libraries

@ghost
Copy link

ghost commented Oct 24, 2022

Tagging subscribers to this area: @dotnet/area-meta
See info in area-owners.md if you want to be subscribed.

Issue Details

null

Author: maryamariyan
Assignees: maryamariyan
Labels:

area-Meta

Milestone: -

@ghost
Copy link

ghost commented Oct 24, 2022

Tagging subscribers to this area: @dotnet/area-extensions-logging
See info in area-owners.md if you want to be subscribed.

Issue Details

null

Author: maryamariyan
Assignees: maryamariyan
Labels:

area-Meta, area-Extensions-Logging

Milestone: -

@maryamariyan maryamariyan force-pushed the readme-logging branch 3 times, most recently from ef2e369 to 609cc82 Compare October 24, 2022 22:41
Copy link
Member

@tarekgh tarekgh left a 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!

@maryamariyan maryamariyan merged commit e468b22 into dotnet:main Oct 25, 2022
@maryamariyan maryamariyan deleted the readme-logging branch October 25, 2022 18:09
@ericstj
Copy link
Member

ericstj commented Oct 27, 2022

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)

@tarekgh
Copy link
Member

tarekgh commented Oct 27, 2022

We might want to mention that these packages are part of the ASP.NET core shared framework in the deployment section.

This is a good point and worth mentioning.

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)

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.

@MSDN-WhiteKnight
Copy link
Contributor

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.

@tarekgh
Copy link
Member

tarekgh commented Oct 30, 2022

I prefer consolidating the library and the package readmes if possible.

relative links to documents within repository will not work when readme is rendered on Nuget gallery.

Can we make those absolute links instead?

@ghost ghost locked as resolved and limited conversation to collaborators Nov 30, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants