[DNS] Document shadowed records and shadow metadata#31731
[DNS] Document shadowed records and shadow metadata#31731matildeopbravo wants to merge 1 commit into
Conversation
|
This pull request requires reviews from CODEOWNERS as it changes files that match the following patterns:
|
4975690 to
ca9e9b5
Compare
There was a problem hiding this comment.
Verdict: 5 style issues need fixing before merge. No build breakers.
Issues:
- HIGH (line 28):
ns1.externalprovider.comis not a reserved example domain and could resolve to a live origin. Replace withns1.example.org. - MEDIUM (line 4):
descriptionexceeds the 160-character limit. Shorten to stay within the style guide range. - MEDIUM (line 9): H1 heading in body content duplicates the frontmatter
title. Remove it to match other pages in this directory. - LOW (line 20): Directional language (
below) andSeeshould beRefer to. - LOW (lines 171, 180): Placeholders
<ns-record-id>should be<NS_RECORD_ID>(uppercase, underscores) per non-API placeholder conventions.
Note: Consider adding products:\n - dns to frontmatter for consistency with sibling reference pages. The changelog checkbox is unchecked — if include_shadow_metadata is new API behavior, add a changelog entry.
|
I have completed the review of PR #31731. Here's a summary of what I did: Labels applied: Review summary: I posted a review comment with 5 inline suggestions/comments. The PR introduces a well-structured DNS reference page for shadowed records and shadow metadata. The main issues I flagged are:
I also noted that the author should consider adding |
|
Preview URL: https://27afc7b6.preview.developers.cloudflare.com Files with changes (up to 15) |
5be14bc to
195b0ba
Compare
b753414 to
0d556f9
Compare
e4cc86a to
124f807
Compare
124f807 to
27afc7b
Compare
Summary
Adds a new DNS reference page documenting shadowed records and the shadow metadata API behavior.
The page explains what shadowed records are, covers glue and dead glue records, and documents the shadow metadata fields (
shadowed_by,is_glue,dead_glue,shadowed_records_count) along with how to request them.Documentation checklist