Repository navigation
Help customers get started with Private DNS #98
Description
Summary
Help customers understand Private DNS and use it successfully without needing knowledge of its internal implementation.
Goal
Provide clear explanations and tested instructions from the first successful lookup through everyday management and troubleshooting.
Scope
Covers customer guides, reference material, and examples for the API, CLI, and Portal. Connector naming is outside this delivery.
Acceptance criteria
- Explain private zones, automatic Compute names, network associations, privacy boundaries, and how public-name lookups continue to work.
- Provide a tested quickstart that takes a customer from setup to a successful private-name lookup.
- Provide guides for custom records, finding services by name, and managing zones and network access through the supported interfaces.
- Document supported locations and runtimes, naming rules, limits, expected update and removal times, and common troubleshooting steps.
- Examples and terminology match the released product, and guides link to relevant operational information where needed.
Activity
scotwells commentedon Oct 29, 2026
We have technical source material in the architecture proposal and monitoring runbook. An architecture and terminology update is also in progress. These explain how the service works, but they do not yet establish a complete customer documentation experience.
The remaining work is to turn that material into a tested quickstart and clear guides for automatic instance names, private zones, records, and network associations. The documentation must explain availability, limits, supported locations and runtimes, and troubleshooting in terms customers can use. Examples need to match the released API, CLI, and Portal. Connector naming is outside this delivery.
[-]Private DNS documentation experience[/-][+]Help customers get started with Private DNS[/+]scotwells commentedon Nov 4, 2026
Progress update: a page naming the Private DNS zone and instance hostnames is in review. The architecture and naming update has merged as source material.
Still needed to close: a tested quickstart, guides for custom records and network access, and reference material on supported locations, limits, update times, and troubleshooting.