Codeberg Pages: Add warning for setting up records on some registrars (#431)

Many users setting up Codeberg Pages that use the records have limited experience with DNS.

Therefore, adding this warning to make it clear what they may need to be entering into
their records will likely save them time and effort in troubleshooting why their page may
not be loading correctly.

Reviewed-on: https://codeberg.org/Codeberg/Documentation/pulls/431
Co-authored-by: Sammy Hori <sammyhori@noreply.codeberg.org>
Co-committed-by: Sammy Hori <sammyhori@noreply.codeberg.org>
This commit is contained in:
Sammy Hori 2024-06-09 14:23:36 +00:00 committed by Panagiotis "Ivory" Vasilopoulos
parent 79d2ac2682
commit 8bd521c7f6

View file

@ -59,6 +59,16 @@ There are several ways DNS records for your website can be setup in order to tel
*We assume for the following description, that you want to serve your website with and without www in front. If you are on a subdomain already (like myproject.yourdomain.com), you can skip the `www.yourdomain.com` CNAME entry.*
{% admonition "Warning" %}
When setting up DNS records with many registrars, any domain added to the `Domain` or `Host` option is automatically appended onto the domain the records are being made for.
For example, if your domain is `example.com`, entering `www` will mean the record refers to `www.example.com`.
Therefore, in this guide, you may need to replace references to just your domain name (e.g. `example.com`) with `@` and `anything.example.com` (i.e. any subdomain) with just `anything`.
{% endadmonition %}
**Option 1: CNAME record**
The easiest and recommended way is to just setup a CNAME record for your domain, pointing to the mentioned above locations. In the end, it should look like this: