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
Organization
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
.ftl Files
These files are the freemarker templates used by jbake to generate the finished documentation module.
.adoc Files
Content is maintained in individual adoc files by topic and is contained in the src/main/resources/content . Freemarker templates will include and organize content base on header info with each partial file. The file documentation.adoc is an empty content file that receives the content from all of the templates and is converted to the documentation.html and documentation.pdf finish product files. The partial content files are grouped into
To ensure compatibility with Windows environments, limit subdirectories to 20 characters and adoc files to 35 characters (30 + .adoc extension).
`_<component>-template.adoc` Files
Generic templates for the minimum documentation to be provided when creating new components. These files are not meant to ever be included, but used as baseline when new components are added and need to be documented.
`config.adoc`
A special file containing asciidoctor configuration settings and variable definitions. Currently only one config is used, but others could be added for special use cases.