Skip to content

Conversation

@RebeccaTamachiro
Copy link
Contributor

Summary

PCX-17295

@github-actions github-actions bot added product:dns Issues or PRs related to DNS size/s labels May 23, 2025
@hyperlint-ai
Copy link
Contributor

hyperlint-ai bot commented May 23, 2025

Howdy and thanks for contributing to our repo. The Cloudflare team reviews new, external PRs within two (2) weeks. If it's been two weeks or longer without any movement, please tag the PR Assignees in a comment.

We review internal PRs within 1 week. If it's something urgent or has been sitting without a comment, start a thread in the Developer Docs space internally.


PR Change Summary

Released the MVP UI for Internal DNS, enhancing user guidance and API integration.

  • Added dashboard and API instructions for creating and deleting DNS views.
  • Introduced tabs for better navigation between dashboard and API instructions.
  • Updated internal zone setup instructions with dashboard and API options.

Modified Files

  • src/content/docs/dns/internal-dns/dns-views.mdx
  • src/content/docs/dns/internal-dns/get-started.mdx
  • src/content/docs/dns/internal-dns/internal-zones/reference-zones.mdx
  • src/content/docs/dns/internal-dns/internal-zones/setup.mdx

How can I customize these reviews?

Check out the Hyperlint AI Reviewer docs for more information on how to customize the review.

If you just want to ignore it on this PR, you can add the hyperlint-ignore label to the PR. Future changes won't trigger a Hyperlint review.

Note specifically for link checks, we only check the first 30 links in a file and we cache the results for several hours (for instance, if you just added a page, you might experience this). Our recommendation is to add hyperlint-ignore to the PR to ignore the link check for this PR.

@github-actions
Copy link
Contributor

github-actions bot commented May 23, 2025

This pull request requires reviews from CODEOWNERS as it changes files that match the following patterns:

Pattern Owners
/src/content/docs/dns/ @RebeccaTamachiro, @cloudflare/pcx-technical-writing
* @cloudflare/pcx-technical-writing

@github-actions
Copy link
Contributor

github-actions bot commented May 23, 2025

Preview URL: https://e60d3b56.preview.developers.cloudflare.com
Preview Branch URL: https://rebecca-idns-mvp-ui-release.preview.developers.cloudflare.com

Files with changes (up to 15)

Original Link Updated Link
https://developers.cloudflare.com/dns/internal-dns/get-started/ https://rebecca-idns-mvp-ui-release.preview.developers.cloudflare.com/dns/internal-dns/get-started/
https://developers.cloudflare.com/dns/internal-dns/dns-views/ https://rebecca-idns-mvp-ui-release.preview.developers.cloudflare.com/dns/internal-dns/dns-views/
https://developers.cloudflare.com/dns/internal-dns/internal-zones/reference-zones/ https://rebecca-idns-mvp-ui-release.preview.developers.cloudflare.com/dns/internal-dns/internal-zones/reference-zones/
https://developers.cloudflare.com/dns/internal-dns/internal-zones/setup/ https://rebecca-idns-mvp-ui-release.preview.developers.cloudflare.com/dns/internal-dns/internal-zones/setup/
https://developers.cloudflare.com/dns/internal-dns/internal-zones/internal-dns-records/ https://rebecca-idns-mvp-ui-release.preview.developers.cloudflare.com/dns/internal-dns/internal-zones/internal-dns-records/
https://developers.cloudflare.com/dns/ https://rebecca-idns-mvp-ui-release.preview.developers.cloudflare.com/dns/
https://developers.cloudflare.com/dns/internal-dns/ https://rebecca-idns-mvp-ui-release.preview.developers.cloudflare.com/dns/internal-dns/
https://developers.cloudflare.com/dns/internal-dns/internal-zones/ https://rebecca-idns-mvp-ui-release.preview.developers.cloudflare.com/dns/internal-dns/internal-zones/

@github-actions github-actions bot added size/m and removed size/s labels May 26, 2025

This comment was marked as off-topic.

@RebeccaTamachiro RebeccaTamachiro marked this pull request as ready for review June 4, 2025 11:13
@RebeccaTamachiro RebeccaTamachiro requested a review from a team as a code owner June 4, 2025 11:13
Copy link
Contributor

@windsurf-bot windsurf-bot bot left a comment

Choose a reason for hiding this comment

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

Other comments (3)

💡 To request another review, post a new comment with "/windsurf-review".

Comment on lines +41 to +96
<Tabs syncKey="dashPlusAPI"> <TabItem label="Dashboard">

<Render file="internal-zone-create-dash" params={{
conditional: "get-started-detail"}}
/>

</TabItem> <TabItem label="API">

<Render file="internal-zone-create-api" params={{
conditional: "get-started-detail"}}
/>

</TabItem> </Tabs>

### (Optional) Reference a zone from another zone

1. Use the [Update DNS settings](/api/resources/dns/subresources/settings/subresources/zone/methods/edit/) endpoint to add a reference from an internal zone to another internal zone. In `--data`, specify the `internal_dns` object with the parameter `reference_zone_id`. For details, refer to [reference zones](/dns/internal-dns/internal-zones/reference-zones/).
<Render file="internal-reference-zone-intro" params={{
conditional: "get-started-link"}}
/>

<Tabs syncKey="dashPlusAPI"> <TabItem label="Dashboard">

1. Go to **Internal DNS** and select a zone.
2. Within the selected zone, go to **Reference zone**.
3. Select **Add reference zone**.
4. Find the zone you want to use as reference and choose **Select** in the respective row.

</TabItem> <TabItem label="API">

1. Use the [Update DNS settings](/api/resources/dns/subresources/settings/subresources/zone/methods/edit/) endpoint to add a reference from an internal zone to another internal zone. In `--json`, specify the `internal_dns` object with the parameter `reference_zone_id`.

<Example>
<Render file="internal-reference-zone-api"/>
</ Example>

</TabItem> </Tabs>

## 2. Link your internal zone to a view

Since the resolver policy will require a [DNS view](/dns/internal-dns/dns-views/), you must have at least one view to be able to route requests to internal zones.

<Tabs syncKey="dashPlusAPI"> <TabItem label="Dashboard">

<Render file="internal-dns-view-create-dash" params={{
conditional: "get-started-detail"}}
/>

</TabItem> <TabItem label="API">

1. Use the [Create Internal DNS View](/api/resources/dns/subresources/settings/subresources/account/subresources/views/methods/create/) endpoint. For each view you create, list all the internal zones that should be grouped under that view.

<Details header="DNS view configuration conditions">
<Render file="internal-dns-view-conditions" />
</Details>

</TabItem> </Tabs>
Copy link
Contributor

Choose a reason for hiding this comment

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

If these tab groups are meant to be independent, assign a unique syncKey to each Tabs component to avoid synchronized tab switching across unrelated sections.


:::note
A wildcard record (`*.example.local`) in the matching internal zone will take precedence over an exact match in a referenced zone.
A wildcard record (`*.example.local`) in the matching internal zone will take precedence over an exact match in a reference zone.
Copy link
Contributor

Choose a reason for hiding this comment

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

Consider standardizing the use of 'reference zone' vs 'referenced zone' throughout the document for consistency and clarity.

<Plan type="enterprise" />

Manage DNS records that should only be accessible within your private network. Internal DNS [zones](/dns/internal-dns/internal-zones/) and [views](/dns/internal-dns/dns-views/) pair up with [Gateway resolver policies](/cloudflare-one/policies/gateway/resolver-policies/) so that you can control how a DNS query should be responded to according to the query context, such as its source IP.
Manage DNS records that should only be accessible within your private network. Internal DNS [zones](/dns/internal-dns/internal-zones/) and [views](/dns/internal-dns/dns-views/) pair up with [Gateway resolver policies](/cloudflare-one/policies/gateway/resolver-policies/) so that you can control how a DNS query should be responded to according to query context, such as query source IP.
Copy link
Contributor

Choose a reason for hiding this comment

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

The revised sentence removes 'the' and 'its', making the sentence less clear. Consider reverting to: 'according to the query context, such as its source IP.' for improved readability.

@RebeccaTamachiro RebeccaTamachiro merged commit 58f5465 into production Jun 6, 2025
11 checks passed
@RebeccaTamachiro RebeccaTamachiro deleted the rebecca/idns-mvp-ui-release branch June 6, 2025 12:18
sdnts pushed a commit to sdnts/cloudflare-docs that referenced this pull request Jul 24, 2025
* Add Dash steps for internal zone creation

* Add tabs components and Dash steps to dns-views

* Revise create a view Dash steps

* Add dash instructions for reference zone assignment

* Get-started: remove api-only and add Dash tab placeholder

* Fix broken link

* Add partial for zone creation and replace in relevant pages

* Add reference zone dash steps and intro to get-started

* Create and apply partial for view-create-dash

* Overall review and add conditions to view creation partial

* Overall review and link to iDNS from docs landing page

* Specify reference at the bottom of internal zones and view is API-only

* Add Internal DNS to /products page

* Remove 'descriptive' specification for zone name

* Update get-started to match Gateway resolver UI text

* Fix typo

* Apply suggestions from code review

Co-authored-by: Maddy <[email protected]>

* Add missing period and implement some page descriptions

---------

Co-authored-by: Maddy <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

product:dns Issues or PRs related to DNS size/m

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants