Skip to content

Commit 23a4449

Browse files
committed
Update domain-structure.md
1 parent ed48c7f commit 23a4449

File tree

1 file changed

+17
-30
lines changed

1 file changed

+17
-30
lines changed

src/domain-structure.md

Lines changed: 17 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,4 @@
1-
---
2-
tags: useful
3-
icon: list-unordered
4-
---
5-
6-
# Domain Structure
1+
# Domains JSON file
72
To register a subdomain, you need to create a new JSON file in the `domains` directory through a pull request. For example, to register `example.is-a.dev`, you would create a file named `example.json` in the `domains` directory. The full path would be `domains/example.json`.
83

94
## Filename
@@ -24,6 +19,7 @@ The filename:
2419
- `a .json` (filename contains a space)
2520
- `a$.json` (filename contains a non-alphanumeric character)
2621
- `a.json.json` (filename contains more than one `.json` extension)
22+
- `a.is-a.dev.json` (filename contains `.is-a.dev`)
2723

2824
### Examples of Valid Filenames
2925
All the filenames below meet all the criteria. The reason in parentheses is just an example of one of the criteria they meet.
@@ -39,16 +35,15 @@ All the filenames below meet all the criteria. The reason in parentheses is just
3935
`domains/docs.json`
4036
```json
4137
{
42-
"description": "Documentation for is-a-dev",
38+
"description": "Documentation website for is-a.dev",
4339
"repo": "https://github.com/is-a-dev/docs",
4440
"owner": {
4541
"username": "is-a-dev",
46-
"email": "hello@maintainers.is-a.dev"
42+
"email": "admin@is-a.dev"
4743
},
4844
"record": {
49-
"URL": "https://www.is-a.dev/docs"
50-
},
51-
"proxied": false
45+
"CNAME": "is-a.dev"
46+
}
5247
}
5348
```
5449

@@ -60,8 +55,7 @@ In the owner object, the fields username and email are required. You can add mor
6055
```json
6156
{
6257
"owner": {
63-
"username": "github-username",
64-
"email": "[email protected]"
58+
"username": "github-username"
6559
}
6660
}
6761
```
@@ -73,18 +67,10 @@ Describe your domain name and your usage. This is purely for documentation purpo
7367
This is a link to your website repository or your github account. This is purely for documentation purpose and is optional.
7468

7569
### record (required)
76-
This section is where you specify the DNS records. The supported types are:
77-
78-
- `CNAME`
79-
- `A`
80-
- `AAAA`
81-
- `URL`
82-
- `MX`
83-
- `TXT`
84-
- `SRV`
85-
- `CAA`
86-
- `NS` (NS records will only be given to users with a [genuine need for them who are trusted users.](https://is-a.dev/docs/faq/))
87-
70+
This section is where you specify the DNS records.
71+
72+
You can see a list of supported types [here](/faq/#which-records-are-supported).
73+
8874
Below are some examples for the given record types:
8975

9076
- **CNAME** record: This must be a hostname (`something.tld`). It cannot be used in conjunction with any other record types. This is typically used to map your domain to a specific server.
@@ -123,7 +109,7 @@ Below are some examples for the given record types:
123109
```json
124110
{
125111
"record": {
126-
"URL": "https://my-other-website.com"
112+
"URL": "https://example.com"
127113
}
128114
}
129115
```
@@ -164,9 +150,7 @@ Below are some examples for the given record types:
164150
}
165151
}
166152
```
167-
!!!warning Note
168-
Please refer to the [frequently asked questions](https://is-a.dev/docs/faq/) for clarification on what or who we allow NS records for. If you want a example on what we want as the reasonings, you can [checkout this PR](https://github.com/is-a-dev/register/pull/16758).
169-
!!!
153+
Note: Please refer to the [frequently asked questions](https://docs.is-a.dev/faq/) for clarification on what or who we allow NS records for. If you want a example on what we want as the reasonings, you can [checkout this PR](https://github.com/is-a-dev/register/pull/16758).
170154

171155
- **SRV** record: This must be a list of service records. Each record specifies the priority, weight, port, and target for a service on your domain. SRV records are often used for services such as VoIP, messaging, and more.
172156
```json
@@ -210,4 +194,7 @@ Please refer to the [frequently asked questions](https://is-a.dev/docs/faq/) for
210194
```
211195

212196
### proxied (*optional*)
213-
Enable Cloudflare proxy for your domain. Disabled by default.
197+
Enable Cloudflare proxy for your domain. Disabled by default. To enable it, add this line of code:
198+
```json
199+
"proxied": true
200+
```

0 commit comments

Comments
 (0)