-
Notifications
You must be signed in to change notification settings - Fork 10.1k
[iDNS] Internal DNS MVP UI release #22632
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
Conversation
|
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 SummaryReleased the MVP UI for Internal DNS, enhancing user guidance and API integration.
Modified Files
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 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 |
|
This pull request requires reviews from CODEOWNERS as it changes files that match the following patterns:
|
This comment was marked as off-topic.
This comment was marked as off-topic.
Sorry, something went wrong.
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.
Other comments (3)
- src/content/docs/dns/internal-dns/get-started.mdx (18-18) Consider re-adding a reference to [API Fundamentals](/fundamentals/api/get-started/) for users who may need help with the API steps.
- src/content/docs/dns/internal-dns/internal-zones/reference-zones.mdx (43-43) Remove the space in the closing `` tag to use the correct `` syntax.
- src/content/docs/dns/index.mdx (20-20) Typo: 'Intenal DNS (Beta)' should be 'Internal DNS (Beta)'.
💡 To request another review, post a new comment with "/windsurf-review".
| <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> |
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.
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. |
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.
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. |
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.
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.
src/content/docs/dns/internal-dns/internal-zones/reference-zones.mdx
Outdated
Show resolved
Hide resolved
* 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]>
Summary
PCX-17295