Skip to content

Commit

Permalink
update faq and emails and stuff
Browse files Browse the repository at this point in the history
  • Loading branch information
wdhdev authored Oct 31, 2024
1 parent 6630e94 commit 4341220
Show file tree
Hide file tree
Showing 3 changed files with 39 additions and 39 deletions.
2 changes: 1 addition & 1 deletion src/docs/domain-structure/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ All the filenames below meet all the criteria. The reason in parentheses is just
"repo": "https://github.com/is-a-dev/docs",
"owner": {
"username": "is-a-dev",
"email": "hello@maintainers.is-a.dev"
"email": "[email protected]"
},
"record": {
"URL": "https://www.is-a.dev/docs"
Expand Down
69 changes: 36 additions & 33 deletions src/docs/faq/index.md
Original file line number Diff line number Diff line change
@@ -1,28 +1,37 @@
# Frequently Asked Questions (FAQ)

## Which records are supported?
We support the following records:

- A
- AAAA
- CAA
- CNAME
- DS
- Note: This can only be used in combination for NS records.
- MX
- TXT
- URL (redirection)
- NS (limited access)
- SRV
- CAA
- TXT
- URL
- Note: This is uses Cloudflare for redirection, it is not a real DNS record type.

## Why does my domain still redirect to the is-a-dev website?
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.

## Can I use a CNAME record with any other records?
You cannot request a subdomain nor submit changes containing a CNAME with any other records (TXT, A, MX, etc...)
You cannot request a subdomain nor submit changes containing a CNAME with any other records (A, AAAA, MX, TXT, etc...)

## How long will it take for my PR to get merged?
When we get into it. We always want you to wait for as short as possible. But maintainers cannot always be online. We have school and work, this is just a side project. Just be patient and we'll get to it as soon as possible! For a chance for a quicker review, send your PR in [⁠pull-requests](https://discord.com/channels/830872854677422150/1130858271620726784).
When we get into it. We always want you to wait for as short as possible. But maintainers cannot always be online. We have school and work, this is just a side project. Just be patient and we'll get to it as soon as possible! For a chance for a quicker review, send your PR in [#⁠pull-requests](https://discord.com/channels/830872854677422150/1130858271620726784) on our [Discord server](https://discord.gg/is-a-dev-830872854677422150).

## Which services do you support?
We support all services. For example: GitHub Pages and Cloudflare Pages.
We support nearly all services, however these are the main services people use with is-a.dev:

- Cloudflare Pages
- GitHub Pages
- Netlify
- Railway
- Vercel

## Can I create nested subdomains? (sub-sub domains)
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`.
Expand All @@ -34,44 +43,38 @@ You can edit your domain's JSON file and submit a pull request to edit your doma
You can delete your domain's JSON file and submit a pull request to delete your domain.

## I keep getting a SSL error while using GitHub Pages, how do i fix this?
You need to go to your GitHub Pages settings on your website repository (likely called `<user.github.io>`) and make sure the `Enforce HTTPS` option is enabled to avoid this error.
You need to go to your GitHub Pages settings on your website repository (likely called something like `github-username.github.i>`) and make sure the `Enforce HTTPS` option is enabled to avoid this error.

## Can I be a maintainer/join the team?
No, we handpick every member of our team. You can increase your chances of being chosen by helping out people in our help forums.

## I have accidentally leaked sensitive information in my PR, how can I get my PR deleted?
If your PR **has not been merged**, you can email [[email protected]](mailto:[email protected]) or DM [williamharrison on Discord](https://discord.com/users/853158265466257448) however, if it has been merged already, then there is nothing we can do about it unfortunately.

## My DNS records are not updating even after 48 hours, what should I do?
Please open a help thread via any of our help channels and we will look into it.
If your PR **has not been merged**, you can 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 nothing we can do about it unfortunately.

## Can I use my domain for a minecraft server?
Sure, but it needs to be a nested subdomain (mc.example.is-a.dev). You would normally use a A record for this.
Yes, you can. You can use an A record combined with an SRV record for this.

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.

## Can I use NS records?
We allow NS records for the following reasons and users:
- is-a.dev maintainers
- Users who are using **multiple** Cloudflare (or similar providers') services, which often require their own zones (e.g., DynDNS, cloudflared tunnels, etc.)
- Users who require a private zone, as they are using their home IP addresses behind Cloudflare (These cases will be carefully reviewed, as we understand some may claim to use a home IP address when they are not.)
- Users with a lot of nested subdomains *may* be allowed to register NS records so they do not have to manage multiple files.
- Aternos users (specifically Aternos, as they require NS records and you cannot modify DNS records under them).

- is-a.dev maintainers
- Users who are using **multiple** Cloudflare (or similar providers') services, which often require their own zones (e.g., DynDNS, cloudflared tunnels, etc.)
- Users who require a private zone, as they are using their home IP addresses behind Cloudflare (These cases will be carefully reviewed, as we understand some may claim to use a home IP address when they are not.)
- Users with a lot of nested subdomains *may* be allowed to register NS records so they do not have to manage multiple files.
- Aternos users (specifically due to the fact that they require NS records and you cannot modify DNS records under them.)

Note: These guidelines are not set in stone and may change. You are not limited to fitting only one of the criteria above; use them as a general guide. [@wdhdev](https://github.com/wdhdev) personally review each NS record request.
Note: These guidelines are not set in stone and may change. You are not limited to fitting only one of the criteria above; use them as a general guide. [@wdhdev](https://github.com/wdhdev) personally reviews each NS record request.

*We reserve the right to deny NS records at our discretion.*

## How can I make changes to my is-a.dev subdomain?

1. **Open your JSON file:** Navigate to the `domains` directory in your local repository and open the JSON file corresponding to your subdomain (`domains/<subdomain>.json`).

1. **Make your changes:** Edit the JSON file (or delete) to reflect the changes you want to make.

1. **Commit your changes:** Once you've made your changes, commit them to your local repository.

1. **Push your changes:** Push your changes to your forked repository on GitHub.

1. **Submit a Pull Request:** Go to your forked repository on GitHub and open a pull request.

1. **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!

**Note:** Make sure to monitor your PR for reviews in case some changes are requested. Also note that it can take up to 48 hours in some cases for your changes to take effect after your PR is merged.
1. **Open your JSON file:** Navigate to the `domains` directory in your fork and open the JSON file corresponding to your subdomain (`domains/subdomain.json`).
2. **Make your changes:** Edit the JSON file (or delete) to reflect the changes you want to make.
3. **Commit your changes:** Once you've made your changes, commit them to your fork.
4. **Push your changes:** Push your changes to your forked repository on GitHub.
5. **Submit a Pull Request:** Go to your forked repository on GitHub and open a pull request.
6. **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!

**Note:** Make sure to monitor your PR for reviews in case some changes are requested.
7 changes: 2 additions & 5 deletions src/docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,18 +16,15 @@ You can read about the domains JSON file structure [here](domain-structure/index
- [Vercel](vercel/index.md)

## Official Subdomains
These are the subdomains run by the is-a.dev staff team. Do not trust any subdomain that is not on this list that claims to be us.
These are the subdomains run by the is-a.dev staff team.

**Websites**:

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

**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]).**

Expand Down

0 comments on commit 4341220

Please sign in to comment.