Skip to content

Commit 4910f42

Browse files
authored
updates + fixes
1 parent 2fed51d commit 4910f42

File tree

3 files changed

+14
-20
lines changed

3 files changed

+14
-20
lines changed

src/docs/domain-structure/index.md

Lines changed: 9 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,7 @@ The filename:
1919
- `a .json` (filename contains a space)
2020
- `a$.json` (filename contains a non-alphanumeric character)
2121
- `a.json.json` (filename contains more than one `.json` extension)
22+
- `a.is-a.dev.json` (filename contains `.is-a.dev`)
2223

2324
### Examples of Valid Filenames
2425
All the filenames below meet all the criteria. The reason in parentheses is just an example of one of the criteria they meet.
@@ -41,7 +42,7 @@ All the filenames below meet all the criteria. The reason in parentheses is just
4142
"email": "[email protected]"
4243
},
4344
"record": {
44-
"URL": "https://is-a.dev/docs"
45+
"CNAME": "is-a.dev"
4546
}
4647
}
4748
```
@@ -66,18 +67,10 @@ Describe your domain name and your usage. This is purely for documentation purpo
6667
This is a link to your website repository or your github account. This is purely for documentation purpose and is optional.
6768

6869
### record (required)
69-
This section is where you specify the DNS records. The supported types are:
70-
71-
- `CNAME`
72-
- `A`
73-
- `AAAA`
74-
- `URL`
75-
- `MX`
76-
- `TXT`
77-
- `SRV`
78-
- `CAA`
79-
- `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/))
80-
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+
8174
Below are some examples for the given record types:
8275

8376
- **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.
@@ -116,7 +109,7 @@ Below are some examples for the given record types:
116109
```json
117110
{
118111
"record": {
119-
"URL": "https://my-other-website.com"
112+
"URL": "https://example.com"
120113
}
121114
}
122115
```
@@ -135,7 +128,7 @@ Below are some examples for the given record types:
135128
```json
136129
{
137130
"record": {
138-
"TXT": ["Hello World!"]
131+
"TXT": "Hello World!"
139132
}
140133
}
141134
```
@@ -157,7 +150,7 @@ Below are some examples for the given record types:
157150
}
158151
}
159152
```
160-
Note: 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).
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).
161154

162155
- **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.
163156
```json

src/docs/index.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -20,12 +20,13 @@ These are the subdomains run by the is-a.dev staff team.
2020

2121
- is-a.dev (the root domain, used for website, docs and emails)
2222
- data.is-a.dev (data website, run by [@wdhdev](https://github.com/wdhdev))
23-
- docs.is-a.dev (redirects to https://is-a.dev/docs)
23+
- docs.is-a.dev (this website)
2424
- owl.is-a.dev (beta user privacy service, run by [@andrewstech](https://github.com/andrewstech) and [@wdhdev](https://github.com/wdhdev))
2525
- raw-api.is-a.dev (raw JSON API of all is-a.dev subdomains, run by [@wdhdev](https://github.com/wdhdev))
2626
- register-bot.is-a.dev (Discord bot API, run by [@andrewstech](https://github.com/andrewstech))
2727
- team.is-a.dev (team documentation)
28+
- www.is-a.dev (redirect to the root domain)
2829

2930
**Do NOT trust any websites claiming to be us that are not listed here. If you find any, please report them to [[email protected]](mailto:[email protected]).**
3031

31-
*We do not unsolicitedly send emails to users, do not trust any unsolicitedly sent emails claiming they are us. Report any scam emails to [[email protected]](mailto:[email protected]).*
32+
*We do not unsolicitedly send emails to users, do not trust any unsolicitedly sent emails claiming they are us. Report any unsolicited emails to [[email protected]](mailto:[email protected]).*

src/docs/other/index.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
# Setting up other services with is-a.dev
22

33
## Setting up records
4-
Read the [domain file structure](/docs/domain-structure) and setup the records accordingly.
4+
Read the [domain file structure](/domain-structure) and setup the records accordingly.
55

66
## Configuring your server
77
After the pull request is merged, configure your server (apache, nginx, etc.) to work with `<subdomain>.is-a.dev`. If you are unsure how to configure your server, you can create an issue for support.
88

9-
You should also, include `<subdomain>.is-a.dev` in your ssl certificate to get rid of certificate errors.
9+
You should also, include `<subdomain>.is-a.dev` in your SSL certificate to get rid of certificate errors.

0 commit comments

Comments
 (0)