Skip to content

Enhance DNS documentation and examples - #49

Merged
ditahkk merged 1 commit into
mainfrom
issues/add-dns-tutorial
Jul 19, 2026
Merged

Enhance DNS documentation and examples#49
ditahkk merged 1 commit into
mainfrom
issues/add-dns-tutorial

Conversation

@ditahkk

@ditahkk ditahkk commented Jul 19, 2026

Copy link
Copy Markdown
Member

What changed

  • Updated the "Domains" documentation to include additional resources for DNS management and troubleshooting.
  • Added a new "DNS Examples" document providing practical recipes for common DNS tasks using the zcp CLI.
  • Created a "DNS Overview" document explaining how zones, name servers, and records work together.
  • Removed the outdated "DNS Records" document and replaced it with individual pages for each record type (A, AAAA, CNAME, MX, TXT, CAA, NS) with detailed explanations and examples.
  • Introduced a "DNS Troubleshooting" document to assist users in resolving common DNS issues.
  • Added a tutorial for hosting a domain on ZCP DNS and managing records using the CLI, covering the entire process from domain creation to verification.

Why


Summary by CodeRabbit

  • New Features

    • Added comprehensive DNS management guides for the Console, CLI, REST API, and Terraform/OpenTofu.
    • Added tutorials, practical examples, record-type references, and troubleshooting guidance.
    • Added support documentation for MX record priorities across CLI, API, and Terraform/OpenTofu.
    • Expanded DNS navigation and CLI command references.
  • Bug Fixes

    • Documented improved public IP cleanup and pagination behavior.
    • Clarified unsupported SRV and LOC record types.
  • Documentation

    • Added French translations for the new DNS content and navigation.

- Updated the "Domains" documentation to include additional resources for DNS management and troubleshooting.
- Added a new "DNS Examples" document providing practical recipes for common DNS tasks using the `zcp` CLI.
- Created a "DNS Overview" document explaining how zones, name servers, and records work together.
- Removed the outdated "DNS Records" document and replaced it with individual pages for each record type (A, AAAA, CNAME, MX, TXT, CAA, NS) with detailed explanations and examples.
- Introduced a "DNS Troubleshooting" document to assist users in resolving common DNS issues.
- Added a tutorial for hosting a domain on ZCP DNS and managing records using the CLI, covering the entire process from domain creation to verification.
@coderabbitai

coderabbitai Bot commented Jul 19, 2026

Copy link
Copy Markdown

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 5bb727f1-5e98-4d00-b434-89388c44da12

📥 Commits

Reviewing files that changed from the base of the PR and between 76e5d35 and 063524a.

📒 Files selected for processing (35)
  • astro.config.mjs
  • src/content/docs/changelog/index.md
  • src/content/docs/fr/changelog/index.md
  • src/content/docs/fr/public-cloud/cli/reference.md
  • src/content/docs/fr/public-cloud/dns/api.mdx
  • src/content/docs/fr/public-cloud/dns/cli.md
  • src/content/docs/fr/public-cloud/dns/domains.md
  • src/content/docs/fr/public-cloud/dns/examples.md
  • src/content/docs/fr/public-cloud/dns/overview.md
  • src/content/docs/fr/public-cloud/dns/records.md
  • src/content/docs/fr/public-cloud/dns/records/a-aaaa.md
  • src/content/docs/fr/public-cloud/dns/records/caa.md
  • src/content/docs/fr/public-cloud/dns/records/cname.md
  • src/content/docs/fr/public-cloud/dns/records/index.md
  • src/content/docs/fr/public-cloud/dns/records/mx.md
  • src/content/docs/fr/public-cloud/dns/records/ns.md
  • src/content/docs/fr/public-cloud/dns/records/txt.md
  • src/content/docs/fr/public-cloud/dns/troubleshooting.md
  • src/content/docs/fr/tutorials/host-dns-on-zcp-cli.md
  • src/content/docs/public-cloud/cli/reference.md
  • src/content/docs/public-cloud/dns/api.mdx
  • src/content/docs/public-cloud/dns/cli.md
  • src/content/docs/public-cloud/dns/domains.md
  • src/content/docs/public-cloud/dns/examples.md
  • src/content/docs/public-cloud/dns/overview.md
  • src/content/docs/public-cloud/dns/records.md
  • src/content/docs/public-cloud/dns/records/a-aaaa.md
  • src/content/docs/public-cloud/dns/records/caa.md
  • src/content/docs/public-cloud/dns/records/cname.md
  • src/content/docs/public-cloud/dns/records/index.md
  • src/content/docs/public-cloud/dns/records/mx.md
  • src/content/docs/public-cloud/dns/records/ns.md
  • src/content/docs/public-cloud/dns/records/txt.md
  • src/content/docs/public-cloud/dns/troubleshooting.md
  • src/content/docs/tutorials/host-dns-on-zcp-cli.md
💤 Files with no reviewable changes (2)
  • src/content/docs/public-cloud/dns/records.md
  • src/content/docs/fr/public-cloud/dns/records.md

📝 Walkthrough

Walkthrough

The PR expands ZCP DNS documentation in English and French, adds per-record guides, API and CLI workflows, examples, troubleshooting, and end-to-end tutorials. It also updates sidebar navigation, CLI references, and release changelogs for DNS-related CLI and provider behavior.

Changes

ZCP DNS documentation

Layer / File(s) Summary
Navigation structure
astro.config.mjs
Adds tutorial and record-type sidebar entries, French labels, and a grouped DNS records section.
Release notes and CLI references
src/content/docs/changelog/index.md, src/content/docs/fr/changelog/index.md, src/content/docs/*/public-cloud/cli/reference.md
Documents MX priority support, provider updates, public IP behavior, pagination changes, and expanded DNS CLI commands.
English DNS guides
src/content/docs/public-cloud/dns/...
Adds DNS overview, API and CLI guides, practical examples, record-type references, domain navigation, and troubleshooting.
French DNS guides
src/content/docs/fr/public-cloud/dns/...
Adds French translations of the DNS overview, API and CLI guides, examples, record references, domain navigation, and troubleshooting.
CLI DNS tutorials
src/content/docs/tutorials/host-dns-on-zcp-cli.md, src/content/docs/fr/tutorials/host-dns-on-zcp-cli.md
Adds English and French tutorials covering authentication, zone creation, record management, delegation, and verification.

Estimated code review effort: 4 (Complex) | ~45 minutes

Possibly related PRs

Suggested reviewers: ditahm6, godsonten, clintonche

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly summarizes the main change: expanding DNS documentation and examples.
Description check ✅ Passed The description clearly summarizes the DNS documentation changes and follows the template structure.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
✨ Finishing Touches
📝 Generate docstrings
  • Create stacked PR
  • Commit on current branch
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch issues/add-dns-tutorial

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@ditahkk
ditahkk merged commit 0f6a181 into main Jul 19, 2026
5 checks passed
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.

1 participant