Skip to content

Commit cf65ae5

Browse files
authored
Update faq.md
1 parent e0b1290 commit cf65ae5

File tree

1 file changed

+107
-62
lines changed

1 file changed

+107
-62
lines changed

src/useful/faq.md

Lines changed: 107 additions & 62 deletions
Original file line numberDiff line numberDiff line change
@@ -4,90 +4,135 @@ label: FAQ
44
route: /faq
55
tags: useful
66
---
7-
# Frequently Asked Questions (FAQ)
87

9-
## Which records are supported?
8+
# 📘 Frequently Asked Questions (FAQ)
109

11-
- A
12-
- AAAA
13-
- CAA
14-
- CNAME
15-
- DS
16-
- Note: These can only be used in combination with NS records, which are used for DNSSEC.
17-
- MX
18-
- NS
19-
- Note: These are only given out in specific cases. Refer to [`Who can use NS records?`](#who-can-use-ns-records) for more information.
20-
- SRV
21-
- TLSA
22-
- TXT
23-
- URL
24-
- Note: These records use Cloudflare for redirection, it is not a real DNS record type.
10+
## Which DNS record types are supported?
2511

26-
## Why does my domain still redirect to the is-a.dev website?
27-
This usually occurs due to the cache of your browser becoming invalid and [clearing your browser's cache](https://support.google.com/accounts/answer/32050) should solve this issue.
12+
We support the following DNS record types:
2813

29-
## Can I use a CNAME record with any other records?
30-
You cannot request a subdomain nor submit changes containing a CNAME with any other records (A, AAAA, MX, TXT, etc...) 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).
14+
* `A`
15+
* `AAAA`
16+
* `CAA`
17+
* `CNAME`
18+
* `DS`
19+
*Note: Must be used alongside `NS` records for DNSSEC.*
20+
* `MX`
21+
* `NS`
22+
*Note: Only approved in specific cases. See [Who can use NS records?](#who-can-use-ns-records) for details.*
23+
* `SRV`
24+
* `TLSA`
25+
* `TXT`
26+
* `URL`
27+
*Note: This is not a true DNS record. It uses Cloudflare’s redirection service.*
3128

32-
## How long will it take for my pull request to get merged?
33-
When we get to it. We always try to shorten users' wait time as much as possible; however, maintainers have lives and cannot always be online. We have school and work; this is just a side project. Remember that all the maintainers are volunteers. Be patient and we'll get to it as soon as possible! For a chance of a quicker review, send your your pull request link in [#⁠pull-requests](https://discord.com/channels/830872854677422150/1130858271620726784) on our [Discord server](https://discord.gg/is-a-dev-830872854677422150).
29+
---
30+
31+
## Why does my domain still redirect to the is-a.dev homepage?
32+
33+
This usually happens due to browser caching. [Clear your browser cache](https://support.google.com/accounts/answer/32050) and try again.
34+
35+
---
36+
37+
## Can I use a CNAME record with other record types?
38+
39+
No — unless the domain is proxied. A `CNAME` cannot be combined with other record types (`A`, `MX`, `TXT`, etc.) in the same record set. For exceptions and setup instructions, see [Proxying Your Domain](https://docs.is-a.dev/domain-structure/#proxied-optional).
40+
41+
---
42+
43+
## How long does it take for my pull request to be merged?
3444

35-
## Which services do you support?
36-
We support nearly all services, however these are the main services people use with is-a.dev:
45+
We're a team of volunteers, and is-a.dev is a side project for us — so review times can vary. We’ll get to your PR as soon as we can. To potentially speed things up, share your PR link in [#pull-requests](https://discord.com/channels/830872854677422150/1130858271620726784) on our [Discord server](https://discord.gg/is-a-dev-830872854677422150).
3746

38-
- Cloudflare Pages
39-
- GitHub Pages
40-
- Netlify
41-
- Railway
42-
- Vercel
47+
---
48+
49+
## Which platforms or services are supported?
50+
51+
While you can use almost any service, these are the most commonly used with is-a.dev:
52+
53+
* Cloudflare Pages
54+
* GitHub Pages
55+
* Netlify
56+
* Railway
57+
* Vercel
58+
59+
---
60+
61+
## Can I create nested subdomains (e.g., `sub.example.is-a.dev`)?
4362

44-
## Can I create nested subdomains? (sub-sub domains)
45-
Yes, you can! Simply create a file such as `blog.example.json` and follow the same guidelines as you would while registering `example.json`. Please note in order to have `blog.example.is-a.dev`, you must also own `example.is-a.dev`. Additionally, you can nest subdomains as much as you can — `example.example.example.is-a.dev` is possible.
63+
Yes! You can nest subdomains as deeply as you'd like. To create one, name your file like `blog.example.json`. You **must own** `example.is-a.dev` to register `blog.example.is-a.dev`.
4664

47-
## I get an SSL error while using GitHub Pages, how do I fix this?
48-
Visit your GitHub Pages settings on your website's repository (most likely labelled similar to `your-github-username.github.io`) and ensure the `Enforce HTTPS` option is enabled to avoid this error.
65+
---
4966

50-
## Can I become a maintainer/join the is-a.dev staff team?
51-
No, we handpick each member of the team. You can increase your chances of being chosen by helping out people in our help forums and channels. This alone, however, will not guarantee in any way a position in the team.
67+
## I get an SSL error using GitHub Pages. How do I fix it?
5268

53-
## I have accidentally leaked sensitive information in my PR, how can I get my PR deleted?
54-
If your PR **has not been merged**, email [[email protected]](mailto:[email protected]) or DM [@williamharrison on Discord](https://discord.com/users/853158265466257448). If your PR has been merged already, then there is unfortunately nothing we can do about it.
69+
Go to your GitHub Pages settings for your repository and **enable "Enforce HTTPS"**. This resolves most SSL issues.
70+
71+
---
72+
73+
## Can I become a maintainer or join the is-a.dev team?
74+
75+
We don’t accept direct applications. Team members are **handpicked**, often based on community involvement and support activity. Even then, it does **not guarantee** a position.
76+
77+
---
78+
79+
## I accidentally leaked sensitive data in my PR — what can I do?
80+
81+
* If **your PR has not been merged**, contact us immediately:
82+
83+
84+
* Discord: [@williamharrison](https://discord.com/users/853158265466257448)
85+
86+
* If your PR **has already been merged**, we cannot retroactively remove it.
87+
88+
---
5589

5690
## Can I use my domain for a Minecraft server?
57-
Yes, you can. You can use an A record combined with an SRV record for this.
5891

59-
Refer to [this article](https://www.namecheap.com/support/knowledgebase/article.aspx/9765/2208/how-can-i-link-my-domain-name-to-a-minecraft-server) by Namecheap for support.
92+
Yes — use an `A` record and an `SRV` record.
93+
Refer to this [Namecheap article](https://www.namecheap.com/support/knowledgebase/article.aspx/9765/2208/how-can-i-link-my-domain-name-to-a-minecraft-server) for guidance.
6094

61-
Please note that you may only do this on a *nested subdomain*, as root subdomains must be related to software development as is required in our [Terms of Service](https://is-a.dev/terms).
95+
> ⚠️ Root subdomains (e.g., `yourname.is-a.dev`) **must relate to software development** as required in our [Terms of Service](https://is-a.dev/terms).
96+
> Use a *nested* subdomain (e.g., `mc.yourname.is-a.dev`) for Minecraft.
97+
98+
---
6299

63100
## Who can use NS records?
64-
We permit NS records for the following reasons:
65101

66-
- The DNS record types we already support are not sufficient for your use case. **Evidence must be provided for your use case and why you require them.**
67-
- When a provider (e.g. Aternos) requires NS delegation, where they maintain the DNS zone, not you. **Supporting documentation must be provided.**
102+
We **allow** NS records only when:
103+
104+
* The standard DNS record types we support aren’t sufficient.
105+
✅ You must provide clear, technical justification.
106+
* A DNS provider (e.g., Aternos) requires NS delegation.
107+
✅ You must provide documentation.
68108

69-
We do not permit NS records for:
109+
We **do not allow** NS records for:
70110

71-
- Convenience-only setups: Where alternatives such as A, AAAA, or CNAME records are sufficient.
72-
- Non-operational purposes
73-
- Lack of evidence for need of use
74-
- Misleading evidence
75-
- Security risks
111+
* Convenience or ease of use
112+
* Unverifiable or unsupported claims
113+
* Non-functional or placeholder purposes
114+
* Security concerns or abuse risk
76115

77-
***We reserve the right to deny NS records at our discretion, no matter the reasoning.***
116+
> ⚠️ **We reserve the right to deny any NS request at our discretion.**
117+
118+
---
119+
120+
## Why are NS records restricted?
121+
122+
NS records give full control over DNS for a subdomain. That opens the door to misuse, abuse, and security concerns. To protect the community and domain integrity, we must be strict about who receives NS delegation.
123+
124+
---
78125

79-
## Why are you so strict with NS records?
80-
We have to be strict with who we delegate NS records to as they allow the end-user to essentially do *whatever they wish* with their subdomain.
126+
## How can I update or delete my is-a.dev subdomain?
81127

82-
As you can probably imagine, this opens the door to a lot of abuse, which is why they are not freely available to everyone.
128+
Follow these steps:
83129

84-
## How can I make changes to or delete my is-a.dev subdomain?
85-
1. **Read this documentation and our [ToS](https://is-a.dev/terms)**: This is so that you can ensure you fully understand the registration process, our requirements, and how to fully comply with our Terms of Service.
86-
2. **Open your JSON file:** Navigate to the `domains` directory in your fork and open the JSON file corresponding to your subdomain (`domains/your-subdomain.json`).
87-
3. **Make your changes:** Edit or delete the JSON file to reflect the changes you want to make.
88-
4. **Commit your changes:** Once you've made your changes, commit them to your fork.
89-
5. **Push your changes:** Push your changes to your forked repository on GitHub.
90-
6. **Submit a pull request:** Navigate to your forked repository on GitHub and open a pull request.
91-
7. **Wait for your PR to be merged:** After you have submitted your pull request, wait for it to be reviewed and merged. Once your pull request has been merged, your changes should be live!
130+
1. **Review the [documentation](https://docs.is-a.dev) and [ToS](https://is-a.dev/terms)**.
131+
2. **Open your JSON file** (in `/domains/your-subdomain.json`).
132+
3. **Make your changes** (or delete the file if you’re removing your domain).
133+
4. **Commit the changes** to your fork.
134+
5. **Push** them to your GitHub fork.
135+
6. **Open a pull request** from your forked repo.
136+
7. **Wait for approval and merging** by a maintainer.
92137

93-
**Note:** Make sure to monitor your PR for reviews in case some changes are requested by a maintainer.
138+
> 💡 Keep an eye on your pull request — we may request changes before merging.

0 commit comments

Comments
 (0)