-
Notifications
You must be signed in to change notification settings - Fork 7
Add Service Binding Records (SVCB and HTTPS) documentation #1762
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
base: main
Are you sure you want to change the base?
Conversation
- Add concept article explaining TLSA records and DANE protocol - Add how-to guide for managing TLSA records - Add reference guide for TLSA record format and components - Add TLSA to supported DNS records list (type 52) - Add TLSA entry to DNS glossary - Update DNS category navigation and main DNS documentation page - Follow diataxis framework and APA style guidelines
Replace <note> tags with GitHub's [!NOTE] callout format
TLSA records require DNSSEC to provide security benefits. Add important callout to inform users they must enable DNSSEC before using TLSA records.
- Add combined explanation article for SVCB and HTTPS records (RFC 9460) - Add combined managing guide for both record types - Update DNS glossary with SVCB and HTTPS entries - Update supported DNS records list - Update categories to include new articles SVCB and HTTPS are functionally identical record types that differ only in naming format. HTTPS uses simpler naming (domain.name) for HTTP/HTTPS services, while SVCB requires explicit service/protocol specification (_service._protocol.domain.name) for any service type.
…s.md - Add links for HINFO, NAPTR, PTR, SSHFP, DS, and DNSKEY records - All record types in the supported records list now link to their documentation articles
- Add explanation article to 'What is DNS?' section - Add managing guide to 'How to manage DNS' section
- Clarify account settings navigation in Domain Access Control article - Update Label domains button description to clarify when it appears - Add clear navigation steps for Integrated Domain Providers Verified against dnsimple-app codebase.
- Add 'Differences Between HTTPS and URL Records' article - Add 'Differences Between HTTPS and ALIAS Records' article - Add both articles to categories/dns.yaml - Add both articles to DNS pillar page explanation section These articles help users understand when to use HTTPS records versus URL records (service binding vs redirects) and HTTPS records versus ALIAS records (service binding vs hostname resolution).
… articles - Add links to CNAME, A, AAAA, MX, and TXT records throughout articles - Add Related articles sections to comparison articles - Add cross-references between explanation, managing, and comparison articles - Ensure all DNS record types mentioned in text are linked to their articles
dallasread
left a comment
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.
That's a lot of content – it's looking good to me. 😅
lokst
left a comment
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.
This looks great!
- Add new article explaining SVCB and HTTPS records (RFC 9460) - Document Record Editor features (simple/advanced modes, validation, live preview, API support) - Update supported-dns-records.md to include SVCB/HTTPS - Add SVCB/HTTPS to Route 53 and CoreDNS supported record types - Note Azure DNS does not support SVCB/HTTPS records - Update record editor documentation to mention SVCB/HTTPS - Add SVCB/HTTPS to DNS category navigation and main DNS article
…vice binding records article - Add Record Editor features section (simple/advanced modes, validation, live preview, API support) - Add Integrated DNS Provider support section (Route 53, CoreDNS support; Azure DNS limitations) - Remove duplicate svcb-https-record.md article
dallasread
left a comment
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 great – nice one! 😎 I made a few comments on things I noticed.
Added a "What is a service binding?" section to the article. It: Defines a service binding as the association between a domain name and the configuration information needed to access a network service Explains the problem it solves (clients needing multiple connection attempts or additional lookups) Lists the capabilities service bindings enable (service discovery, protocol negotiation, connection optimization, domain aliasing)
needed to add
Managing Service Binding Records (SVCB and HTTPS)
What Are Service Binding Records (SVCB and HTTPS)?
Summary
This PR adds comprehensive documentation for Service Binding Records (SVCB and HTTPS) as specified in RFC 9460.
Changes
New articles:
service-binding-records.md- Combined explanation article for SVCB and HTTPS recordsmanage-service-binding-records.md- Combined managing guide for both record typesUpdated articles:
dns-glossary.md- Added SVCB and HTTPS entriessupported-dns-records.md- Added SVCB (type 64) and HTTPS (type 65) to supported records listcategories/dns.yaml- Added new articles to categoriesKey Points
domain.namewhile SVCB uses_service._protocol.domain.nameDocumentation Structure
Following DNSimple's documentation patterns:
Ready for review.