Skip to content

Email Contact — Documentation #307

@bmertens-datum

Description

@bmertens-datum

High-Level Summary

Create internal and external documentation for the new Email Contact system in Datum Cloud.
Documentation should cover the data model, API usage, UI workflows, and permission model so teams can use and support the feature confidently.

Motivation

Clear documentation ensures that engineering, support, and service provider teams understand how to create and manage contacts, handle preferences, and use contact lists.
It also reduces onboarding friction and future support load.

Goals

  • Document the Contact and ContactList resource models (fields, relationships, namespaces)
  • Document the Kubernetes-style API usage patterns
  • Document UI workflows for managing contacts, preferences, and lists
  • Document required roles/permissions for managing contacts
  • Provide example manifests and example usage flows
  • Publish docs to the Datum developer portal and internal handbook

Non-Goals

  • User-facing marketing or help center content
  • End-user self-service preference documentation
  • Deep operational runbooks or SRE playbooks (covered separately later)

Metadata

Metadata

Assignees

Labels

No labels
No labels

Type

Projects

No projects

Relationships

None yet

Development

No branches or pull requests

Issue actions