How aveva/connect-data-services-developer-docs works
This repository is CONNECT Data Services developer documentation, not the data-services runtime. Its primary user journey is to learn platform concepts in the developer guide, then consult the API reference while implementing a capability. The repository also contains DocFX template transformations for conceptual, managed-reference, REST, universal-reference, and table-of-contents pages. README-described platform features are represented as documented subject areas, not as implementation services. Template relationships are limited to calls and imports visible in the supplied excerpts; unsampled template and content internals are not inferred.
Main entry points: RestApi.common.js REST model transform · ManagedReference.common.js Managed reference model · UniversalReference.common.js Universal reference model · RestApi.html.primary.js REST page transform
Components 34
Developer guide
- Developer guide
content/developer-guide - Identity guidance
content/developer-guide/identity-dev - SDS guidance
content/developer-guide/sequential-data-store-dev - Data view guidance
content/developer-guide/data-views-dev - Asset guidance
content/developer-guide/asset-dev - OMF guidance
content/developer-guide/omf-dev
API reference
- API reference
content/api-reference - Identity APIs
content/api-reference/identity - SDS APIs
content/api-reference/sequential-data-store - Data view APIs
content/api-reference/data-views - Asset APIs
content/api-reference/assets - OMF ingress APIs
content/api-reference/data-ingress/omf-ingress - Event GraphQL APIs
content/api-reference/event-graphql-api - Rules APIs
content/api-reference/rules - Tenant APIs
content/api-reference/tenant - Community APIs
content/api-reference/community
Documented capabilities
- Data collection
content/developer-guide/omf-dev - Data context
content/developer-guide/asset-dev - Time-series storage
content/developer-guide/sequential-data-store-dev - Data access
content/developer-guide/data-views-dev - REST delivery
content/api-reference
DocFX templates
- REST page transform
_exported_templates/default/RestApi.html.primary.js - REST model transform
_exported_templates/default/RestApi.common.js - REST extension hooks
_exported_templates/default/RestApi.extension.js - Managed reference transform
_exported_templates/default/ManagedReference.html.primary.js - Managed reference model
_exported_templates/default/ManagedReference.common.js - Managed extension hooks
_exported_templates/default/ManagedReference.extension.js - Universal reference transform
_exported_templates/default/UniversalReference.html.primary.js - Universal reference model
_exported_templates/default/UniversalReference.common.js - Universal extension hooks
_exported_templates/default/UniversalReference.extension.js - Conceptual hooks
_exported_templates/default/conceptual.extension.js - TOC transform
_exported_templates/default/toc.html.js - TOC hooks
_exported_templates/default/toc.extension.js
Other components
- Developer
Connections 16
- Developer → Developer guide: starts with
README.md - Developer guide → API reference: then consults
README.md - Data collection → Data context: adds context
README.md - Data context → Time-series storage: stores data
README.md - Time-series storage → Data access: enables access
README.md - Data access → REST delivery: delivers via REST
README.md - REST page transform → REST model transform: transforms with
_exported_templates/default/RestApi.html.primary.js - REST page transform → REST extension hooks: calls hooks
_exported_templates/default/RestApi.html.primary.js - REST model transform → REST model transform: uses helpers
_exported_templates/default/RestApi.common.js - Managed reference transform → Managed reference model: transforms with
_exported_templates/default/ManagedReference.html.primary.js - Managed reference transform → Managed extension hooks: calls hooks
_exported_templates/default/ManagedReference.html.primary.js - Managed reference model → Managed reference model: uses helpers
_exported_templates/default/ManagedReference.common.js - Universal reference transform → Universal reference model: transforms with
_exported_templates/default/UniversalReference.html.primary.js - Universal reference transform → Universal extension hooks: calls hooks
_exported_templates/default/UniversalReference.html.primary.js - Universal reference model → Universal reference model: uses helpers
_exported_templates/default/UniversalReference.common.js - TOC transform → TOC hooks: calls hooks
_exported_templates/default/toc.html.js