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

READMEs for Service Discovery #792

Merged
merged 15 commits into from
Nov 14, 2023
Merged

READMEs for Service Discovery #792

merged 15 commits into from
Nov 14, 2023

Conversation

ReubenBond
Copy link
Member

@ReubenBond ReubenBond commented Nov 13, 2023

Fixes #187.
cc @IEvangelist

Copy link
Member

@IEvangelist IEvangelist left a comment

Choose a reason for hiding this comment

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

Some suggestions and nits. LTGM! Well done...


## Feedback & contributing

https://github.com/dotnet/aspire
Copy link
Member

Choose a reason for hiding this comment

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

Why not link to the issues tab, perhaps with as specific issue template? Or a discussion board, or maybe a Discord channel? Are there any plans for any of those things? The contributing.md talks nothing about the GitHub open-source flow, or expectations dev should have coming to the repo. We should really make it feel a bit more inviting.

@@ -0,0 +1,63 @@
# Microsoft.Extensions.ServiceDiscovery.Dns

This library provides support for resolving service endpoints using DNS (Domain Name System). It provides two service endpoint resolvers:
Copy link
Member

Choose a reason for hiding this comment

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

Consider linking to NuGet, even if this README.md is used in the package itself, developers will read this on GitHub and want the link.

src/Microsoft.Extensions.ServiceDiscovery.Dns/README.md Outdated Show resolved Hide resolved
src/Microsoft.Extensions.ServiceDiscovery.Dns/README.md Outdated Show resolved Hide resolved
src/Microsoft.Extensions.ServiceDiscovery/README.md Outdated Show resolved Hide resolved
src/Microsoft.Extensions.ServiceDiscovery/README.md Outdated Show resolved Hide resolved
src/Microsoft.Extensions.ServiceDiscovery/README.md Outdated Show resolved Hide resolved
src/Microsoft.Extensions.ServiceDiscovery/README.md Outdated Show resolved Hide resolved
src/Microsoft.Extensions.ServiceDiscovery/README.md Outdated Show resolved Hide resolved
ReubenBond and others added 14 commits November 13, 2023 20:35
@ReubenBond ReubenBond enabled auto-merge (squash) November 14, 2023 04:40
@ReubenBond ReubenBond merged commit 3ec2292 into main Nov 14, 2023
5 checks passed
@ReubenBond ReubenBond deleted the rebond/sd-readmes branch November 14, 2023 05:03
@github-actions github-actions bot locked and limited conversation to collaborators Apr 29, 2024
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.

Add READMEs to Service Discovery packages
3 participants