Skip to content

Add CAA records docs#3017

Merged
adityaoberai merged 6 commits into
mainfrom
add-caa-docs
May 20, 2026
Merged

Add CAA records docs#3017
adityaoberai merged 6 commits into
mainfrom
add-caa-docs

Conversation

@adityaoberai
Copy link
Copy Markdown
Contributor

What does this PR do?

(Provide a description of what this PR does.)

Test Plan

(Write your test plan here. If you changed any code, please provide us with clear instructions on how you verified your changes work.)

Related PRs and Issues

(If this PR is related to any other PR or resolves any issue or related to any issue link all related PR and issues here.)

Have you read the Contributing Guidelines on issues?

(Write your answer here.)

@adityaoberai adityaoberai requested a review from eldadfux May 20, 2026 19:39
@appwrite
Copy link
Copy Markdown

appwrite Bot commented May 20, 2026

Appwrite Website

Project ID: 69d7efb00023389e8d27

Sites (1)
Site Status Logs Preview QR
 website
69d7f2670014e24571ca
Ready Ready View Logs Preview URL QR Code

Website (appwrite/website)

Project ID: 684969cb000a2f6c0a02

Sites (1)
Site Status Logs Preview QR
 website
68496a17000f03d62013
Queued Queued View Logs Preview URL QR Code


Tip

Deploy functions via zip upload or connect directly to your Git repo

@greptile-apps
Copy link
Copy Markdown
Contributor

greptile-apps Bot commented May 20, 2026

Greptile Summary

This PR adds a new dedicated documentation page for Certification Authority Authorization (CAA) records and cross-links it from the custom domains, TLS, DNS, and Sites domains pages. It explains when CAA records are required, how to add them, how to handle multiple CAs, and how wildcard and apex/subdomain scoping work.

  • New caa-records/+page.markdoc covers the full CAA lifecycle: the certainly.com CA value for Appwrite Cloud, apex vs. subdomain inheritance, multiple-record additive behavior, wildcard issuewild handling, and a troubleshooting checklist.
  • Existing pages (custom-domains, tls, dns, sites/domains) are updated with inline links and callouts clarifying that existing CAA records must be kept alongside any new Appwrite record.

Confidence Score: 5/5

Documentation-only change adding a new CAA records page and updating cross-links; no logic or runtime code is affected.

All changes are Markdoc content and a single nav entry in a Svelte layout. The new page accurately describes CAA record behavior per RFC 8659, correctly identifies certainly.com as Fastly/Appwrite's CA, and handles edge cases (multiple CAs, wildcard issuewild, apex vs. subdomain inheritance). Cross-links are consistent and step numbering in custom-domains was updated correctly.

No files require special attention.

Important Files Changed

Filename Overview
src/routes/docs/products/network/caa-records/+page.markdoc New CAA records documentation page explaining when and how to add a CAA record for Appwrite's CA (certainly.com), including apex/subdomain scoping, multiple records, wildcard certificates, and troubleshooting.
src/routes/docs/products/network/+layout.svelte Adds "CAA records" nav entry between DNS and DDoS mitigation in the network section sidebar.
src/routes/docs/advanced/platform/custom-domains/+page.markdoc Inserts a new conditional step 5 for adding a CAA record and renumbers the subsequent verification and SSL steps correctly.
src/routes/docs/advanced/security/tls/+page.markdoc Appends a new "CAA records" section noting that certainly.com must be authorized when a domain has restrictive CAA records, with a link to the new dedicated page.
src/routes/docs/products/network/dns/+page.markdoc Adds inline links to the new CAA records page in the DNS record type table and CNAME flattening instructions, plus an info callout about keeping existing CAA records.
src/routes/docs/products/sites/domains/+page.markdoc Updates step 6 and 9 in the apex domain setup to link to the CAA records page and clarify that existing CAA records should not be replaced.

Reviews (5): Last reviewed commit: "Apply suggestion from @adityaoberai" | Re-trigger Greptile

Comment thread src/routes/docs/products/network/caa-records/+page.markdoc Outdated
adityaoberai and others added 3 commits May 21, 2026 01:14
Co-authored-by: greptile-apps[bot] <165735046+greptile-apps[bot]@users.noreply.github.com>
Comment thread src/routes/docs/advanced/security/tls/+page.markdoc Outdated
Comment thread src/routes/docs/products/network/caa-records/+page.markdoc Outdated
Comment thread src/routes/docs/products/network/caa-records/+page.markdoc Outdated
Comment thread src/routes/docs/products/network/caa-records/+page.markdoc Outdated
Comment thread src/routes/docs/products/network/caa-records/+page.markdoc
@adityaoberai adityaoberai merged commit d7b4ccc into main May 20, 2026
6 checks passed
@adityaoberai adityaoberai deleted the add-caa-docs branch May 20, 2026 20:21
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants