Skip to content
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
33 changes: 28 additions & 5 deletions src/guides/netlify.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,9 +13,15 @@ This guide will walk you through the process of setting up a Netlify deployment

First, create a website on Netlify. Follow the instructions in the [Netlify Docs](https://docs.netlify.com/).

## Adding the domain to Netlify

To get the records for Netlify, navigate to **Site Settings > Domain Management > Custom Domains** and add `subdomain.is-a.dev` (as an example, you should add the domain which you want to register) in the given field.

### Creating the Domain File

Create a JSON file inside the `domains` directory (`domains/subdomain.json`) with the following content and submit a pull request:
You should see two domains that Netlify added, `subdomain.is-a.dev` and `www.subdomain.is-a.dev`. You have to make both of them so that you can successfully add a domain to Netlify. (`subdomain` being your domain name of choice, of course)

Create a JSON file inside the `domains` directory called `subdomain.json` with the following content:

```json
{
Expand All @@ -28,13 +34,30 @@ Create a JSON file inside the `domains` directory (`domains/subdomain.json`) wit
}
}
```
!!!
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.
!!!

After that, create another JSON file in the same directory called `www.subdomain.json` with the following content:
```json
{
"owner": {
"username": "github-username",
"email": "me@example.com"
},
"records": {
"CNAME": "website.netlify.app"
}
}
```
!!!
Note: The CNAME record should be what Netlify gave you, which should be most of the time the website's domain which Netlify generated, like `website.netlify.app`.
!!!

**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.
After you've made both of the files, make a pull request and wait.

## Configuring Netlify
- 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.
- Navigate to **Site Settings > Domain Management > Custom Domains** and add `subdomain.is-a.dev` in the given field.
- 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`).
- After your pull request is merged, you should be able to connect the domain with Netlify.

### Final Steps
- Wait for the DNS changes to propagate. This can take from a few minutes to a couple of hours.
Expand Down