-
Notifications
You must be signed in to change notification settings - Fork 9
Group 13 DNS Article Rework #1628
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
Merged
Merged
Changes from 17 commits
Commits
Show all changes
26 commits
Select commit
Hold shift + click to select a range
f74baee
Group 13 DNS Article Rework
itsalyse bcfc7bf
Delete content/files/domain-dns-hosting-enable.png
itsalyse f1d86f8
Delete content/files/inactive-zone.png
itsalyse 3fe8caa
Update dns.yaml
itsalyse 0e318e6
Create interface-reference.md
itsalyse c59adcf
Update dns.yaml
itsalyse ba077f0
Update interface-reference.md
itsalyse 7730ffe
Create record-editor-simple-field.md
itsalyse 692a21a
Update dns.yaml
itsalyse 2d5a0ee
Update record-editor.md
itsalyse c168d18
Update record-editor.md
itsalyse 2919cad
Update dns-hosting.md
stephanoodle d1de584
Update record-editor-simple-field.md
itsalyse 4dd4b40
Update record-editor-simple-field.md
itsalyse 981b769
Delete content/files/dns-tab.png
itsalyse 02eedea
Delete content/files/custom-vs-system-record.png
itsalyse 010f0f9
Update record-editor.md
itsalyse c4a7e31
Update search.spec.js
gronk-droid 23ed138
Merge branch 'main' into group-13-article-rework
gronk-droid 3bf36f3
Fix test catching
gronk-droid a08e011
Add files via upload
stephanoodle 77d9a51
Add files via upload
stephanoodle 551e0b1
Update interface-reference.md
stephanoodle 5d39246
Update interface-reference.md
stephanoodle d716c18
Update interface-reference.md
stephanoodle e6fd209
Update dns.yaml
stephanoodle File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,63 @@ | ||
| --- | ||
| title: DNSimple Interface Reference for DNS Management | ||
| excerpt: Key pages related to DNS management in the DNSimple interface. | ||
| meta: This document provides a labeled visual reference for key pages related to DNS management in the DNSimple interface. | ||
| categories: | ||
| - DNS | ||
| --- | ||
|
|
||
| # DNSimple Interface Reference for DNS Management | ||
|
|
||
| This document provides a visual reference for key pages related to DNS management in the DNSimple interface. Each screenshot is labeled with numbers that correspond to an explanation of that feature or element. | ||
|
|
||
| ## Record Editor | ||
| The [Record Editor](/articles/record-editor/) is where you manage your domain's DNS records. You can add, edit, or delete records from this page. | ||
|
|
||
| <!--- needs screenshot --> | ||
|
|
||
| 1. **Add record**: Click this button to create a new DNS record. | ||
| 1. **Import/Export**: Click this button to import your zone file from another provider or to export a copy of your DNSimple zone file. | ||
| 1. **Record Note**: The note icon adds a note to an existing record. | ||
| 1. **Edit Record**: The pencil icon edits an existing record. | ||
| 1. **Delete Recor**d: The trash can icon deletes a record. | ||
|
|
||
| ## DNS tab | ||
| The DNS tab on your domain's management page provides an overview of your DNS zone and access to key features. | ||
|
|
||
| <!--- needs screenshot --> | ||
|
|
||
stephanoodle marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| 1. **DNS**: This tab shows the status of your DNS zone and provides access to other DNS features. | ||
| 1. **DNS**: This link directs you to the Record Editor, where you can manage your domain's DNS records. | ||
| 1. **Deactivate zone**: This button shows if your DNS zone is active. | ||
| 1. **DNS Zone Providers**: This card shows your current DNS providers and provides options to add other Integrated DNS Providers. | ||
| 1. **Manage**: This links you to the Record Editor, where you can manage your domain's DNS records. | ||
| 1. **Export**: Click this button to export your zone file. A download will initiate. | ||
| 1. **Import**: Click this button to import a zone file. | ||
|
|
||
| ## Import zone | ||
| The Import zone page allows you to import your zone file from another provider. | ||
|
|
||
| <!--- needs screenshot --> | ||
|
||
|
|
||
| 1. **Zone Data**: This field is where you paste the zone file data. | ||
| 1. **Import Zone**: Click this button to import your zone file. | ||
|
|
||
| ## Integrated Providers | ||
| The [Integrated Providers](/articles/integrated-dns-providers/) page in your account settings allows you to connect and manage external DNS providers. | ||
|
|
||
| <!--- needs screenshot --> | ||
|
||
|
|
||
| 1. **Integrated Providers**: This tab shows the status of your integrated providers. | ||
| 1. **Connect an integrated provider**: This card shows a list of providers you can connect to. | ||
| 1. **Suggest a provider**: Click this link to suggest a provider that is not on the list. | ||
| 1. **Connected providers**: This card shows a list of providers you are already connected to. | ||
|
|
||
| ## Integrated DNS Provider on Domain Names Page | ||
| The Domain Names page provides an overview of all your domains and their DNS zone status. | ||
|
|
||
| <!--- needs screenshot --> | ||
|
||
|
|
||
| 1. **DNS Zones**: This column shows the status of your DNS zone and the provider it is integrated with, if it has one. | ||
|
|
||
| ## Have more questions? | ||
| If you have additional questions or need any assistance, just [contact support](https://dnsimple.com/feedback), and we'll be happy to help. | ||
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,55 @@ | ||
| --- | ||
| title: Understanding DNSimple's Record Editors Simple vs. Field-Specific | ||
| excerpt: The Record Editor gives you the ability to view, create, and manage the DNS records for a domain. | ||
| categories: | ||
| - DNS | ||
| --- | ||
|
|
||
| # Understanding DNSimple's Record Editors: Simple vs. Field-Specific | ||
|
|
||
| DNSimple provides two distinct interfaces for adding and managing your DNS records in the [Record Editor](/articles/record-editor/), each designed to optimize for different use cases: the simple editor and the record fields editor. While both achieve the same goal of configuring your domain's DNS, they offer different levels of guidance and flexibility. Understanding when to use each can streamline your DNS management process. | ||
|
|
||
| ## The simple editor: flexible for common records and pasting | ||
| The Simple Editor presents a streamlined interface, primarily asking you to provide three universal pieces of information for a DNS record: | ||
| - **Name**: This is the hostname for the record (e.g., `www`, `blog`, `_dmarc`). | ||
| - Leave it blank to configure a record for the root domain (e.g., `example.com`). | ||
| - Enter the subdomain part for a specific hostname (e.g., `subdomain`). | ||
| - You can also enter an `*` for a wildcard record, which matches any subdomain not explicitly defined. | ||
| - **Content**: This is a single, free-form text field where you enter the entire content of the DNS record's data. | ||
| - **TTL (Time-to-Live)**: This value determines how long DNS lookups for that record can be cached by resolvers around the internet. The default value is typically 1 hour (3600 seconds), but you can adjust it. | ||
|
|
||
|  | ||
|
|
||
| ### When to use the simple editor | ||
| The simple editor is highly beneficial for: | ||
| - Adding common, straightforward records like A records or basic TXT records where the content is a single IP address or a simple text string. | ||
| - Pasting DNS record content directly from a third-party service provider. Many services (like email providers or site verification tools) will provide you with a full record string (e.g., `"v=spf1 include:_spf.google.com ~all"` for [SPF](/articles/spf-record/)). The Simple Editor allows you to paste this directly into the Content field, letting DNSimple handle the parsing. | ||
|
|
||
| Check out [How to Add Common DNS Records](/articles/how-to-add-dns-records/) for more information on how to create these common records in DNSimple. | ||
|
|
||
| ## The record fields editor: guided input for complex records | ||
| The record fields editor is a specialized form available for certain DNS record types. Instead of a single `Content` field, it breaks down the record's data into separate, specific input fields. | ||
|
|
||
| **How it works**: For records like [MX](/articles/mx-record/), [SRV](/articles/srv-record/), or [CAA](/articles/caa-record/), which have multiple distinct parts (e.g., priority, weight, port, specific tags), the Record Fields Editor provides individual fields for each component. | ||
|
|
||
| ### When to use the record fields editor | ||
| This editor is particularly useful for: | ||
| - **Complex record types**: It guides you through entering the correct data for records that have multiple, structured parts (e.g., separating priority, weight, port for [SRV records](/articles/add-srv-record/), or specific tags for [CAA records](/articles/manage-caa-record/)). | ||
| - **Enhanced error messages**: By having discrete fields, the editor can provide more specific and helpful validation messages in real-time, reducing errors during configuration. For example, it might warn you if a port number is out of range or if a hostname isn't a valid format for a specific field. | ||
| - **Ensuring correct formatting**: It ensures that each part of the record is entered in the correct format, even if you're not intimately familiar with the RFC specifications. | ||
|
|
||
| ## Switching between editors | ||
| You can typically switch between the simple editor and the record fields editor using the tabs provided at the top of the record creation/editing interface. This allows you the flexibility to paste a full string in the simple editor and then switch to the record fields editor to review the parsed components, or vice-versa. | ||
|
|
||
| ## Why DNSimple offers both editors | ||
| DNSimple provides both editing experiences to cater to different user needs and preferences: | ||
|
|
||
| **Flexibility for experts**: Experienced users or those integrating with third-party services can quickly paste raw record content. | ||
|
|
||
| **Guidance for all users**: The structured fields help ensure accuracy for complex records, providing clear guidance and validation to minimize errors. This simplifies DNS management for users regardless of their technical expertise. | ||
|
|
||
| ## Have more questions? | ||
| If you have additional questions or need any assistance with your DNS records, just [contact support](https://dnsimple.com/feedback), and we'll be happy to help. | ||
|
|
||
|
|
||
|
|
Oops, something went wrong.
Oops, something went wrong.
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.
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.
https://drive.google.com/file/d/11hkCrccgt-Kh_b6CKw5XalFdkl8SVh61/view?usp=sharing