Documentation is organized by audience and purpose. The top-level sections are:
Introduction
Introduction to DDF as a product and notes on documentation conventions.
Core Concepts
High-level, non-technical overview of the primary functions and capabilities of DDF.
Managing
Specific "How-to" sections written for the people who will be maintaining instances of DDF. This section is further sub-divided into:
- Installing: Setting up a new instance from start to finish
- Configuring: Setting or updating the settings for an instance. Includes security and hardening instructions.
- from the Admin Console
- from the Command Line
- by editing Configuration files
- by exporting an existing configuration and importing into the new one
- Quickstart: getting a test/evaluation instance started quickly.
- Running
- Starting
- from script
- as a service
- Monitoring: system health and metrics
- Data Management:
- Ingesting
- Maintaining data integrity
- Starting
- Using:
- Walkthroughs of UIs, Landing page.
Integrating
External APIs used by Integrators to communicate with DDF
- Data and Metadata
- Endpoints
- Eventing
- Sources
- Security Services
Developing
Details of Internal interfaces needed to extend functionality of existing components, or create new implementations.
- System Data Flow
- Catalog Framework API
- Developing Sources
- Transformers
- Plugins
- Operations
- Resources
- Queries
- Security Framework
- Metrics
- Action Framework
- Migration API
- Application Service API
- General Development Guidelines
Appendices
Reference sections to be linked to by the other sections:
- Application Reference
- Application Whitelists
- All File Formats Supported
- DDF Dependency List