GA updates for Internal DNS#32018
Open
esomoza-cf wants to merge 1 commit into
Open
Conversation
esomoza-cf
requested review from
a team,
Woutifier,
chreo,
dklbreitling,
elithrar,
hannes-cf,
kerolasa,
matildeopbravo,
svenr-cf,
vendemiat and
xofyarg
as code owners
Contributor
ReviewReviewing new changes (commit
Fix in your agentFix the following review findings in PR #32018 (https://github.com/cloudflare/cloudflare-docs/pull/32018).
Before making changes, review each finding and present a brief summary table:
- For each finding, state whether you agree, disagree, or need clarification
- If you disagree (e.g. the fix requires disproportionate effort for minimal benefit,
or the finding is factually incorrect), explain why
- If you need clarification before deciding, ask those questions
- Then share your plan for which issues to tackle and in what order
After triaging, fix all legitimate findings. For any you decide to skip,
post a comment on this PR with the finding ID and your reasoning.
---
## Code Review
### Warnings (2)
#### CR-0f593fcb669e · Incorrect API token scoping guidance
- **File:** `src/content/docs/dns/internal-dns/authentication.mdx` line 85
- **Issue:** The explanation says the POST /zones request succeeds only if the token already includes `corp.local`. When creating the zone for the first time, a zone-scoped token cannot include a zone that does not yet exist, and the parenthetical fallback referring to 'a zone that already exists' contradicts the creation scenario. This conflicts with the 'Common issues' table, which correctly states an account-level or 'All zones' token is needed for creation.
- **Fix:** Clarify that creating the zone requires an account-level or 'All zones' token (Zone > Zone > Edit), while later record-management calls require the specific zone scope.
#### CR-987dbb6c2859 · Invalid YAML frontmatter indentation
- **File:** `src/content/docs/dns/internal-dns/index.mdx` line 7
- **Issue:** The `sidebar:` key at line 7 is indented under `title: Internal DNS` (line 6), making it a child of a scalar mapping key. The following indented lines (8-11) further nest under `sidebar`, producing malformed frontmatter that the YAML parser will reject.
- **Fix:** Dedent `sidebar:` and its children so they are siblings of `title:` in the frontmatter mapping.
### Suggestions (1)
#### CR-d4f40b02a6ec · Unused import
- **File:** `src/content/docs/dns/internal-dns/authentication.mdx` line 14
- **Issue:** The `Details` component is imported from `~/components` but never used in the page.
- **Fix:** Remove the unused `Details` import.
---
## Style Guide Review
### Warnings (2)
#### SG-040c870ee3c7 · Avoid directional words
- **File:** `src/content/docs/dns/internal-dns/authentication.mdx` line 45
- **Issue:** Line adds `(see table above)`
- **Fix:** Replace `above` with a direct reference to the table by name or link.
#### SG-6517ae7ec875 · Directional words
- **File:** `src/content/docs/dns/internal-dns/internal-zones/setup.mdx` line 44
- **Issue:** Line contains `Refer to the API documentation below for details:`
- **Fix:** Replace `below` with a direct reference, for example: `Refer to the following API documentation for details:`
### Suggestions (3)
#### SG-a4907496a9a5 · Time-sensitive content
- **File:** `src/content/docs/dns/internal-dns/authentication.mdx` line 108
- **Issue:** Heading adds `Attribute-based permissions (coming soon)`
- **Fix:** Remove `coming soon`; docs must read as timeless.
#### SG-d93a3bca5271 · Bullet list with fewer than three items
- **File:** `src/content/docs/dns/internal-dns/authentication.mdx` line 112
- **Issue:** Section introduces a two-item bullet list (`All zones where type = internal`, `All zones where name ends_with ".local"`)
- **Fix:** Consider writing the two examples as prose instead of a bullet list.
#### SG-669c44cadf25 · Time-sensitive content
- **File:** `src/content/docs/dns/internal-dns/authentication.mdx` line 115
- **Issue:** Line adds `We expect this capability to land in late 2026.`
- **Fix:** Remove or rewrite without the year reference.
Code ReviewThis code review is in beta and may not always be helpful — use your judgment. Warnings (2)
Suggestions (1)
ConventionsNo convention issues found. Style Guide ReviewWarnings (2)
Suggestions (3)
CommandsOnly codeowners can run commands. Post a comment with the command to trigger it.
|
github-actions
Bot
assigned
chreo,
dklbreitling,
elithrar,
hannes-cf,
kerolasa,
matildeopbravo,
svenr-cf,
vendemiat,
Woutifier and
xofyarg
Contributor
|
This pull request requires reviews from CODEOWNERS as it changes files that match the following patterns:
|
- CR-987dbb6c2859: Fix YAML frontmatter indentation in index.mdx - CR-d4f40b02a6ec: Remove unused Details import - CR-0f593fcb669e: Clarify zone creation requires account-level token - SG-040c870ee3c7: Replace directional word 'above' with table reference - SG-6517ae7ec875: Replace directional word 'below' - SG-a4907496a9a5: Remove time-sensitive 'coming soon' from heading - SG-d93a3bca5271: Convert two-item bullet list to prose - SG-669c44cadf25: Remove year reference from attribute-based permissions
esomoza-cf
force-pushed
the
internal-dns-ga-remove-beta
branch
from
82c2431 to
6552a2e
Compare
Contributor
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
11 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Screenshots (optional)
Documentation checklist