System-End/dns
1
0
Fork 0
mirror of https://github.com/System-End/dns.git synced 2026-04-20 00:25:21 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Add more clear documentation about what to do when you're removing a CNAME and putting other records (#1641)

Browse source 
* Update README.md

* add examples

---------

Co-authored-by: Cara Salter <cara@devcara.com>
This commit is contained in:
Alex Park 2025-03-28 21:24:42 -05:00 • committed by GitHub
parent f06f48e09e
commit 16f95e6aa0
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
1 changed files with 7 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

12
README.md
View file

@ -25,13 +25,15 @@ That's it! Someone with contributor access to the repo will then review your PR.
If you're asked to make any changes to your pull request, please amend it by commiting to your fork, instead of closing it and creating another.
### Google Workspace / Vercel Combination
### Replacing a `CNAME` record with another record type
If you're looking to use both Google Workspace and Vercel, deploying your changes may break. To fix this, follow these steps (each in a seperate step, `irvine.hackclub.com` is an example of this process):
The CNAME record cannot coexist with other record types, which may require you to change to an `ALIAS` or `A` record type if you need additional DNS records on your subdomain. Due to a bug in OctoDNS, removing a CNAME may result in deploying your changes breaking. You might encounter this when trying to use both Vercel and email/Google Workspace on the same subdomain.
1. Delete all records associated to your subdomain.
2. Add the records needed for Google Workspace to your subdomain.
3. Add the remaining records you'd like for your subdomain. Instead of a `CNAME`, use `ALIAS`.
To fix this, follow these steps, each in a seperate PR:
1. Make a PR that deletes all records on your subdomain (ex: [#1642](https://github.com/hackclub/dns/pull/1642)).
2. Make another PR that adds the additional records needed, replacing the `CNAME` with the other record that you want (oftentimes `ALIAS`) (ex: [#1643](https://github.com/hackclub/dns/pull/1643)).
3. Make it clear to the person reviewing your PRs that the first PR must be merged before the second one.
## Limitations