Documentation

User and administrator manuals

The seven DataNivra manuals — quick start, user, administrator, agent installation, security and architecture, enterprise deployment, and API/CLI/SDK — and how they stay true to the product.

The manual set

DataNivra keeps seven manuals, written for different readers. They are supplementary: every console screen carries its own help panel, so the product is usable without reading a manual end to end.

ManualForStart here on this site
Quick StartEveryoneStart free and Getting started
User GuideData owners, TDM engineers, developers and QAThe learning center and Integrations
Administrator GuideOrganisation owners and administratorsPricing and the support center
Agent Installation GuidePlatform and infrastructure engineersAgent installation and Downloads
Security and Architecture GuideSecurity reviewersSecurity, Trust and Known limitations
Enterprise Deployment GuideEnterprise buyers and operatorsEnterprise and Operator runbooks
API, CLI and SDK GuideDevelopers and CI/CD ownersAPI overview, API reference, CLI and SDKs

How the manuals stay true

The manuals are Markdown sources in the product repository (docs/manuals). Their fact tables are generated from the same definitions the product runs on, and a check fails the build when a table is stale:

  • the plan table from the plan catalog the control plane enforces (limits, trial length and how to obtain each plan — never prices);
  • the connector table from the connector capability registry (available, preview or planned);
  • every API operation from the route contract, and every CLI command from the CLI itself;
  • the console pages from the console's route table and sidebar;
  • every error code from the support error catalog;
  • every configuration variable of the control plane, the sandbox runner and the agent from their settings models.

A printable manual (DOCX, and PDF where a converter is available) is built from the same sources, leading with the self-service path: start free, your organisation and tenant, the sandbox, agent installation, the free trial, billing and the enterprise path.

Status words

The manuals say Available only for what is implemented and tested, Coming in this release for work being finished, Owner action where an external account (payments, email, image registry) still has to be configured by DataNivra, and Planned for designed but unimplemented capabilities. Known limitations are listed on Known limitations and residual risks.

← All documentation