Skip to content

Commit a230768

Browse files
authored
Merge pull request #84 from is-a-dev/services
feat: remove description and repo fields from domain structure
2 parents ec03df9 + 2e70189 commit a230768

File tree

2 files changed

+19
-54
lines changed

2 files changed

+19
-54
lines changed

src/guides/vercel.md

Lines changed: 10 additions & 48 deletions
Original file line numberDiff line numberDiff line change
@@ -12,17 +12,12 @@ This guide will walk you through the process of setting up a Vercel site and poi
1212

1313
If you haven't made a Vercel site, make sure to make one. Follow the instructions in [Vercel's Docs](https://vercel.com/docs/getting-started-with-vercel).
1414

15-
### Creating the domain files
15+
### Creating the domain
1616

17-
First, go to your Vercel dashboard, then go to your project, then go to Custom Domains and enter the is-a.dev subdomain you want.
18-
19-
**You will need to make two files to ensure this process goes smoothly**. We will go in order for this section.
20-
21-
1. Make a file for Vercel TXT verification.
22-
When connecting the domain, you will be greeted with a TXT verification string. To make the file for this one the TXT record should be placed in `_vercel.subdomain.json` in the **domains directory** (replace subdomain with the domain you want of course) and the file should be like this:
23-
!!!
24-
You can also replace the email with any form of social media handle (Like Discord, Twitter, Bluesky, Mastodon etc.).
25-
!!!
17+
1. Navigate to your Vercel dashboard. Then, navigate to the "Domains" tab of your project's settings. Click "Add Domain" and enter the is-a.dev subdomain you want (e.g. `example.is-a.dev`).
18+
2. Once you're past the "Configure Environment and Redirects" tab—if unsure, just click "Save"—then click "Continue manually". Copy the TXT verification value that you'll get; you'll need this in step 4.
19+
3. Fork our [repository](https://github.com/is-a-dev/register) and create a file **in the `/domains` folder** named `your-domain.json`. Replace `your-domain` with the name of the subdomain you chose earlier in the Vercel dashboard.
20+
4. In this file, paste the following JSON and ***make sure to replace all the values properly***, except for the CNAME, which you should leave untouched.
2621

2722
```json
2823
{
@@ -31,50 +26,17 @@ You can also replace the email with any form of social media handle (Like Discor
3126
"email": "[email protected]"
3227
},
3328
"records": {
34-
"TXT": "insert-TXT-string-you-got-from-vercel-here"
35-
}
36-
}
37-
```
38-
39-
!!!
40-
**_DON'T MAKE A PULL REQUEST YET_**, we still have to make another file. If you were to make a pull request at this point, we would reject your domain since you are trying to make a nested subdomain on a subdomain you don't own yet. Please proceed to the next step.
41-
!!!
42-
43-
2. Create a file for the main domain.
44-
Now you need to make a file for the main domain, we have two ways to do it: CNAME and A records. We'll have two different files for these and explain what restricions or stuff you need to do.
45-
46-
Create `subdomain.json` in the **domains directory** (replace subdomain with the domain you want of course) and put in the file one of these types:
47-
48-
**CNAME record**: If you are using CNAME record you don't have to give a preview as you are using the site as the CNAME, but you can't use other record (Like MX and TXT records) unless the domain is proxied. For information on how to proxy a domain, see [proxying your domain](https://docs.is-a.dev/domain-structure/#proxied-optional).
49-
50-
```json
51-
{
52-
"owner": {
53-
"username": "your-github-username",
54-
"email": "[email protected]"
29+
"CNAME": "cname.vercel-dns.com"
5530
},
56-
"records": {
57-
"CNAME": "domainname.vercel.app"
31+
"services": {
32+
"vercel": "insert-TXT-string-you-got-from-vercel-here"
5833
}
5934
}
6035
```
6136

62-
**A record**: If you are using an A record, you would need to give a preview either by putting a link in the comment section of the PR, putting it in the description, or by providing a screenshot of your website. **This option is ideal for those who want to use their domain for their site and email**.
63-
64-
```json
65-
{
66-
"owner": {
67-
"username": "your-github-username",
68-
"email": "[email protected]"
69-
},
70-
"records": {
71-
"A": ["76.76.21.21"]
72-
}
73-
}
74-
```
7537

7638
### Make a pull request
7739

78-
Once you have made these two files, you can now make a pull request to the [main repo](https://github.com/is-a-dev/register). Then you'll have to be patient until it gets merged. If you want a chance to get your PR merged faster then join our [Discord server!](https://discord.gg/is-a-dev-830872854677422150).
40+
Once you have created your file, make a pull request to the [main repository](https://github.com/is-a-dev/register). Then you'll need to be patient until it gets merged. If you want a chance to get your PR merged faster, join our [Discord server](https://discord.gg/is-a-dev-830872854677422150) and send your pull request link ***once*** in `#pull-requests`.
7941

80-
When the pull request has been merged your site should be working; if it is still redirecting to the is-a.dev site try clearing your cache.
42+
Once the pull request has been merged your site should be working; if it is still redirecting to the is-a.dev site, try clearing your cache.

src/useful/domain-structure.md

Lines changed: 9 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -65,12 +65,6 @@ In the owner object, the fields `username` and `email` are required. You may add
6565
}
6666
```
6767

68-
### `description`
69-
Describe your domain name and your usage. This is purely for documentation purpose and is optional.
70-
71-
### `repo`
72-
This is a link to your website repository or your GitHub account. This is purely for documentation purpose and is optional.
73-
7468
### `records` (required)
7569
This section is where you specify the DNS records.
7670

@@ -237,6 +231,15 @@ Note: Please refer to the [frequently asked questions](https://docs.is-a.dev/faq
237231
"digest": "C2074462471B81206F792AEC23469EF33DDC53538E8580DCCC92FD130C9A6096"
238232
}]
239233
```
234+
### `services` (*optional*)
235+
This section is for the verification records of certain services. Here is an example of all currently available options:
236+
```json
237+
"services": {
238+
"discord": "dh=examplestring123",
239+
"vercel": "vc-domain-verify=example.is-a.dev,example123",
240+
"bluesky": "did=did:plc:example123"
241+
}
242+
```
240243

241244
### `proxied` (*optional*)
242245
Enable Cloudflare proxy for your domain. This is disabled by default. To enable it, add this line of code:

0 commit comments

Comments
 (0)