Documentation is organized by audience and purpose.
Included Documentation
For each version of the documentation, the following materials are published and included in the distribution:
Introduction
The Introduction contains basic info for getting started setting up and using DDF.
Core Concepts
Core Concepts contains high-level, non-technical overviews of the main features of DDF.
Quick Start
The Quick Start guide has instructions for getting a test/evaluation instance started quickly. NOTE: for a full, working installation, see Managing
Managing
The Managing section features 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.
- Running:
- Starting
- Monitoring: system health and metrics
- Data Management:
Using
- The Using section contains how-to sections for User Interfaces.
Integrating
The Integrating documentation contains explanations and how-to sections for APIs used by Integrators to communicate with DDF.
Developing
The developing section contains explanations of Internal interfaces needed to extend functionality of existing components.
- System Data Flow
- Catalog Framework API
- Developing Sources
- Transformers
- Plugins
- Operations
- Resources
- Queries
- Security Framework
- Metrics
- Action Framework
- Migration API
- Application Service API
How-to information on developing custom implementation
- General Development Guidelines
Appendices
Reference sections to be linked to by the other sections:
- Application Reference
- Application Whitelists
- Metadata Attributes
- DDF Dependency List
Release Notes
View the Release Notes for current and past versions to see changes within versions and troubleshooting data.