Skip to content

Commit 7000228

Browse files
authored
Merge pull request #76 from orangci/main
refactor(docs-en): fix grammar issues and typos, add MX priority and TLSA documentation, and other errors
2 parents 6464dff + e98693d commit 7000228

17 files changed

+189
-167
lines changed

src/guides/cloudflare-pages.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -4,17 +4,17 @@ icon: /media/cloudflare.svg
44
tags: guides
55
---
66

7-
# Setting up Cloudflare Pages with is-a-dev subdomain
7+
# Setting up Cloudflare Pages with an is-a.dev subdomain
88

9-
This guide will walk you through the process of setting up a Cloudflare Pages site and pointing your is-a.dev subdomain to it.
9+
This guide will walk you through the process of setting up a Cloudflare Pages website and pointing your is-a.dev subdomain towards it.
1010

11-
## Create a Cloudflare Pages Site
11+
## Create a Cloudflare Pages Website
1212

13-
First, you'll need to create a site on Cloudflare Pages. Follow the instructions in the [Cloudflare Pages Getting Started Guide](https://developers.cloudflare.com/pages/get-started/guide/).
13+
First, you'll need to create a website on Cloudflare Pages. Follow the instructions in the [Cloudflare Pages Getting Started Guide](https://developers.cloudflare.com/pages/get-started/guide/).
1414

1515
### Point your subdomain to your Cloudflare Pages site
1616

17-
Next, you'll need to point your is-a.dev subdomain to your Cloudflare Pages site. Follow the instructions in the [Cloudflare Pages Custom Domains Guide](https://developers.cloudflare.com/pages/platform/custom-domains/#add-a-custom-domain). Only follow the "Add a custom domain" section, then return to this guide for the next steps.
17+
Next, you'll need to point your is-a.dev subdomain to your Cloudflare Pages website. Follow the instructions in the [Cloudflare Pages Custom Domains Guide](https://developers.cloudflare.com/pages/platform/custom-domains/#add-a-custom-domain). Only follow the "Add a custom domain" section, and then return to this guide for the next steps.
1818

1919
### Create the Domain File
2020

@@ -24,14 +24,14 @@ In the `domains` directory, create a new JSON file for your subdomain (`domains/
2424
{
2525
"owner": {
2626
"username": "your-github-username",
27-
"email": "your-email@gmail.com"
27+
"email": "your-email@example.com"
2828
},
2929
"record": {
3030
"CNAME": "your-sitename.pages.dev"
3131
}
3232
}
3333
```
3434

35-
### Your site should be live!
35+
### Your website should be live!
3636

37-
If you have followed all the steps correctly, then your site should be live after your pull request has been merged.
37+
If you have followed all the steps correctly, then your website should be live after your pull request has been merged.

src/guides/codeberg-pages.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -4,33 +4,33 @@ icon: /media/codeberg.svg
44
tags: guides
55
---
66

7-
# Setting up Codeberg Pages with is-a-dev subdomain
7+
# Setting up Codeberg Pages with an is-a.dev subdomain
88

9-
This guide will walk you through the process of setting up a Codeberg Pages site and pointing your is-a.dev subdomain to it.
9+
This guide will walk you through the process of setting up a Codeberg Pages website and pointing your is-a.dev subdomain to it.
1010

11-
## Create a Codeberg Pages Site
11+
## Create a Codeberg Pages Website
1212

13-
First, you'll need to create a site on Codeberg Pages. Follow the instructions in the [Codeberg Pages Guide](https://docs.codeberg.org/codeberg-pages/).
13+
First, you'll need to create a website on Codeberg Pages. Follow the instructions in the [Codeberg Pages Guide](https://docs.codeberg.org/codeberg-pages/).
1414

1515
### Create the Domain File
1616

17-
Create a JSON file inside domains directory (domains/subdomain.json) with the following content and submit a pull request:
17+
Create a JSON file inside domains directory (`domains/subdomain.json`) with the following content and submit a pull request:
1818

1919
```json
2020
{
2121
"owner": {
2222
"username": "your-codeberg-username",
23-
"email": "your-email@gmail.com"
23+
"email": "your-email@example.com"
2424
},
2525
"record": {
26-
"CNAME": "pages.your-username.codeberg.page"
26+
"CNAME": "pages.your-codeberg-username.codeberg.page"
2727
}
2828
}
2929
```
3030

3131
### Add `.domains` file
3232

33-
Once your PR is merged, Make a `.domains` file to point your website to your new .is-a.dev domain and add your subdomain (`your-subdomain.is-a.dev`) to it.
33+
Once your PR is merged, Make a `.domains` file to point your website to your new `.is-a.dev` domain and add your subdomain (`your-subdomain.is-a.dev`) to it.
3434

3535
### Done!
3636

src/guides/dbh.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -4,13 +4,13 @@ tags: guides
44
icon: /media/dbh.png
55
---
66

7-
# Setting up DanBot Hosting with is-a.dev subdomain
7+
# Setting up DanBot Hosting with an is-a.dev subdomain
88

9-
This guide will walk you through the process of setting up a DanBot Hosting site and pointing your is-a.dev subdomain to it.
9+
This guide will walk you through the process of setting up a DanBot Hosting website and pointing your is-a.dev subdomain to it.
1010

1111
## Getting Proxy IP
1212

13-
Execute the following command in [DanBot Hosting Discord server](https://discord.gg/dbh) in the #commands channel.
13+
Execute the following command in [DanBot Hosting Discord server](https://discord.gg/dbh) in the `#commands` channel.
1414

1515
```
1616
dbh!server proxy
@@ -20,7 +20,7 @@ You will get a reply like this:
2020

2121
![](../media/dbh_proxy/1.jpg)
2222

23-
If you are on free plan, choose any US proxy or you can use the Donator Proxy If you are a Donator, then note the IP address of the proxy you chose.
23+
If you are on a free plan, choose any US proxy or you can use the Donator Proxy If you are a Donator, note the IP address of the proxy you chose.
2424

2525
### Creating the domain file
2626

@@ -40,11 +40,11 @@ Create a JSON file inside `domains` directory (`domains/subdomain.json`) with th
4040
}
4141
```
4242

43-
**Note:** In the owner section, you can add any social media handle, such as Discord. If you add another social media account, you can omit the email field. However, the GitHub username is mandatory. Don't forget to provide a preview of your site in your pull request.
43+
**Note:** In the owner section, you can add any social media handle, such as Discord. If you add another social media account, you may omit the email field. However, the GitHub username is mandatory. Don't forget to provide a preview of your website in your pull request.
4444

4545
## Configuring
4646

47-
After the pull request is merged, get your server ID by running this command:
47+
After your pull request is merged, get your server ID by running this command:
4848

4949
```
5050
dbh!server list

src/guides/discord-verification.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ label: Discord Domain Connection
44
tags: guides
55
---
66

7-
# Setting up Discord domain connection with your is-a.dev domain
7+
# Setting up Discord domain connection with your is-a.dev subdomain
88

99
## Get your verification string
1010

@@ -33,8 +33,8 @@ Create a JSON file inside the `domains/` directory called `domains/_discord.exam
3333
```json
3434
{
3535
"owner": {
36-
"username": "github-username",
37-
"email": "email@address"
36+
"username": "your-github-username",
37+
"email": "your-email-address@example.com"
3838
},
3939
"record": {
4040
"TXT": "discord-verification-string"
@@ -45,4 +45,4 @@ Create a JSON file inside the `domains/` directory called `domains/_discord.exam
4545
## Configuration
4646

4747
After your pull request has been merged, repeat the steps to get the verification string and press the `Verify` button.
48-
If it shows any error such as `Unable to verify your domain`, try waiting a few minutes (sometimes up to 24 hours) as the DNS might have not been updated yet.
48+
If it shows any error such as `Unable to verify your domain`, try waiting a few minutes (sometimes up to 24 hours) as the DNS might not have propagated yet.

src/guides/github-pages.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ icon: mark-github
44
tags: guides
55
---
66

7-
## Setting up GitHub pages with is-a.dev subdomain
7+
## Setting up GitHub pages with an is-a.dev subdomain
88

99
This guide will walk you through the process of setting up a GitHub Pages site and pointing your is-a.dev subdomain to it.
1010

@@ -32,15 +32,15 @@ Create a JSON file inside `domains` directory (`domains/subdomain.json`) with th
3232

3333
### Configuring
3434

35-
- After the pull request is merged, you may see a **404** error on `subdomain.is-a.dev` or the wrong site. To fix this, go to your GitHub pages repository's **Settings > GitHub pages > Custom Domain** and add `subdomain.is-a.dev` in the given field. _Only do this **after** your pull request is merged._
35+
- After the pull request is merged, you may see a **404** error on `subdomain.is-a.dev` or the wrong site. To fix this issue, go to your GitHub pages repository and navigate to: **Settings > GitHub pages > Custom Domain** and add `subdomain.is-a.dev` in the given field. *Only do this **after** your pull request is merged.*
3636
- Check the **Enforce HTTPS** checkbox below the custom domain input.
3737
- Wait some time and your site should be live!
3838

39-
## Verifying your is-a.dev Domain with GitHub Pages
39+
## Verifying your is-a.dev Subdomain with GitHub Pages
4040

4141
### Get your verification string
4242

43-
1. Open GitHub, press on your profile icon on the top right, and press `Settings`.
43+
1. Navigate to GitHub, press your profile icon at the top right, and press `Settings`.
4444

4545
![](../media/github_pages_verification/step_1.png)
4646

@@ -52,7 +52,7 @@ Create a JSON file inside `domains` directory (`domains/subdomain.json`) with th
5252

5353
![](../media/github_pages_verification/step_3.png)
5454

55-
4. In the field that appears, type your is-a.dev domain name (e.g. `myname.is-a.dev`) and press `Add domain`.
55+
4. In the field that appears, type your is-a.dev subdomain name (e.g. `myname.is-a.dev`) and press `Add domain`.
5656

5757
![](../media/github_pages_verification/step_4.png)
5858

@@ -79,4 +79,4 @@ Create a JSON file inside the `domains/` directory called `domains/hostname.subd
7979
### Configuration
8080

8181
After your pull request has been merged, repeat the steps to get the verification string and press the `Verify` button.
82-
If it shows any error such as `Unable to verify your domain`, try waiting a few minutes (sometimes up to 24 hours) as the DNS change might not have reflected on the DNS server.
82+
If it shows an error such as `Unable to verify your domain`, try waiting a few minutes (sometimes up to 24 hours) as the DNS records may not have propagated yet.

src/guides/hashnode.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ tags: guides
66

77
# Hashnode Blog
88

9-
When you create your Hashnode blog, Hashnode provides a free `hashnode.dev` subdomain for you. However, you can set up your own `is-a.dev` subdomain.
9+
When you create your Hashnode blog, Hashnode provides a free `hashnode.dev` subdomain for you. However, you can alternatively set up your own `is-a.dev` subdomain.
1010

1111
In this guide, you will learn how to accomplish this.
1212

src/guides/improvmx.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -4,20 +4,20 @@ icon: /media/improvmx.svg
44
tags: guides
55
---
66

7-
# Setting up ImprovMX with is-a.dev subdomain
7+
# Setting up ImprovMX with an is-a.dev subdomain
88

99
This guide will walk you through the process of setting up ImprovMX with your is-a.dev subdomain.
1010

11-
## What you need to do before you continue.
11+
## Requirements
1212

13-
1. Have a ImprovMX account. If you don't have a ImprovMX account, please go to [their site](https://improvmx.com) and make a account.
13+
1. You must have an ImprovMX account. If you don't have an ImprovMX account, please visit [their website](https://improvmx.com) and create an account.
1414
2. You should have already forked the [is-a.dev repository](https://github.com/is-a-dev/register). If you haven't forked the repository, please make one by using [this link](https://github.com/is-a-dev/register/fork).
1515

16-
## Making the file.
16+
## Creating the file
1717

18-
First go to the fork you've made, then go into the `domains` directory and make a file. The file should be named like this: `subdomain.json`. (Replace `subdomain` with the subdomain name you want of course.)
18+
Visit your fork and navigate into the `domains` directory and create a file. The file should be named in this manner: `subdomain.json`. (Replace `subdomain` with the subdomain name that you want.)
1919

20-
After you've made the file, you should put in the file this:
20+
After you've made the file, it should look like this:
2121
```json
2222
{
2323
"owner": {
@@ -31,8 +31,8 @@ After you've made the file, you should put in the file this:
3131
}
3232
```
3333

34-
**After you have made the file, you should make a pull request to the [is-a.dev repository](https://github.com/is-a-dev/register).**
34+
**After you've made the file, make a pull request to the [is-a.dev repository](https://github.com/is-a-dev/register).**
3535

3636
## Configuring
3737

38-
After it has been merged, it should be automatically recognized and should start working. If you haven't configured it beforehand, please go to the [ImprovMX dashboard](https://app.improvmx.com/) and add the domain there.
38+
After your pull request has been merged, the MX records should be recognized automatically and start working. If you haven't configured it beforehand, please go to the [ImprovMX dashboard](https://app.improvmx.com/) and add the subdomain there.

src/guides/netlify.md

Lines changed: 8 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -4,13 +4,13 @@ label: Netlify
44
tags: guides
55
---
66

7-
# Setting up Netlify with is-a.dev Subdomain
7+
# Setting up Netlify with an is-a.dev Subdomain
88

9-
This guide will walk you through the process of setting up a Netlify deployment and pointing your is-a.dev subdomain to it.
9+
This guide will walk you through the process of setting up a Netlify deployment and pointing your is-a.dev subdomain towards it.
1010

11-
## Creating a Netlify Site
11+
## Creating a Netlify Website
1212

13-
First, you'll need to create a site on Netlify. Follow the instructions in the [Netlify Docs](https://docs.netlify.com/).
13+
First, create a website on Netlify. Follow the instructions in the [Netlify Docs](https://docs.netlify.com/).
1414

1515
### Creating the Domain File
1616

@@ -30,15 +30,13 @@ Create a JSON file inside the `domains` directory (`domains/subdomain.json`) wit
3030
}
3131
```
3232

33-
**Note:** In the owner section, you can add any social media handle, such as Discord. If you add another social media account, you can omit the email field. However, the GitHub username is mandatory. Don't forget to provide a preview of your site in your pull request.
33+
**Note:** In the owner section, you can add any social media handle, such as Discord. If you add another social media account, you can omit the email field. However, the GitHub username is mandatory. Don't forget to provide a preview of your website in your pull request.
3434

3535
## Configuring Netlify
36-
37-
- After the pull request is merged, you may need to configure your Netlify site to use the new subdomain. Go to your Netlify site's dashboard.
36+
- After your pull request is merged, you may need to configure your Netlify website to use the new subdomain. Visit your Netlify website's dashboard.
3837
- Navigate to **Site Settings > Domain Management > Custom Domains** and add `subdomain.is-a.dev` in the given field.
39-
- Netlify will provide a verification step, usually requiring you to add a DNS record. This step should be skipped if your subdomain is already pointing to Netlify's IP address (`75.2.60.5`).
38+
- Netlify will provide a verification step, usually requiring you to add a DNS record. You should be able to skip this step if your subdomain is already pointing to Netlify's IP address (`75.2.60.5`).
4039

4140
### Final Steps
42-
4341
- Wait for the DNS changes to propagate. This can take from a few minutes to a couple of hours.
44-
- Your Netlify site should now be accessible at `subdomain.is-a.dev`.
42+
- Your Netlify website should now be accessible at `your-subdomain.is-a.dev`.

src/guides/other.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,10 +8,10 @@ tags: guides
88

99
## Setting up records
1010

11-
Read the [domain file structure](../useful/domain-structure) and setup the records accordingly.
11+
Read the [domain file structure](../useful/domain-structure) and set up the records accordingly.
1212

1313
## Configuring your server
1414

15-
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.
15+
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](https://github.com/is-a-dev/register/issues/new/choose) for support.
1616

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

src/guides/railway.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -19,8 +19,8 @@ tags: guides
1919
```json
2020
{
2121
"owner": {
22-
"username": "your-username",
23-
"email": "your-email"
22+
"username": "your-github-username",
23+
"email": "your-email@example.com"
2424
},
2525
"record": {
2626
"CNAME": "the-value-railway-gave-you"
@@ -29,9 +29,9 @@ tags: guides
2929
```
3030
9. After you have made the file, you should make a pull request.
3131
!!!
32-
**Adding the website preview is neccessary**, since the CNAME value Railway gives you doesn't actually show you the website you are running.
32+
**Adding the website preview is mandatory**, since the CNAME value Railway gives you doesn't actually show you the website you are running.
3333
!!!
3434

3535

36-
**If the PR has been merged, the DNS records will be updated in a few minutes.**
37-
**If the PR has been merged but the DNS records haven't updated and you have waited 48 hours, open a GitHub issue or a help thread in the is-a.dev discord server.**
36+
- **If the PR has been merged, the DNS records will be updated in a few minutes.**
37+
- **If the PR has been merged but the DNS records haven't updated and you have waited 48 hours, [open a GitHub issue](https://github.com/is-a-dev/register/issues/new/choose) or a help thread in the is-a.dev [Discord server]((https://discord.gg/is-a-dev-830872854677422150)).**

0 commit comments

Comments
 (0)